ChatBootAI - OpenAPI

This repository contains the ChatBootAI OpenAPI Contract as well as many generated languages stubs and models. The directory structure is as follows:

.
├── LICENSE
├── README.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── java                        # The generated Java SDK
│   ├── jakarta-api             # The Jakarta EE REST API
│   ├── jakarta-model           # The Jakarta EE Model
│   ├── jaxrs-api
│   └── jaxrs-model
├── javascript
│   ├── javascript-api
│   └── javascript-model
├── python
│   ├── python-api
│   └── python-model
└── openapi                  
    ├── openapi-chatbootai.yml  # The ChatBootAI OpenAPI Contract
    └── generated-sources       # The temporary generated sources
        ├── java
        ├── javascript
        └── python

The ChatBootAI OpenAPI Contract

The ChatBootAI OpenAPI Contract in located under the openapi.yml file.

You can also visualize the OpenAPI Contract using the OpenAPI online editor

Manually Generating the model and APIs from the ChatBootAI OpenAPI Contract

OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, and documentation automatically given an OpenAPI Spec. Swagger CodeGen supports several programming languages. Execute the following command to see the list of supported languages and framworks:

openapi-generator list

You will something like this:

CLIENT generators:
    - ada
    - android
    - apex
    - bash
    - c
    - clojure
    - cpp-qt-client
    - cpp-restsdk
    - cpp-tiny (beta)
    - cpp-tizen
    - cpp-ue4 (beta)
    ...

For example, to generate a Java client library from the ChatBootAI OpenAPI Contract, run the following command:

openapi-generator generate -i openapi-chatbootai.yml -g jaxrs-spec -o ./java/java-api --api-package ai.chatboot.api --model-package ai.chatboot.model

References

• OpenAPI Initiative and the OpenAPI Specification
• The OpenAPI API Reference for the OpenAI endpoints
• The OpenAI OpenAPI contract
• Chat Backend Protocol
• OpenAPI Generator
• OpenAPI online editor
• Kiota