forked from loafle/openapi-generator-original
8862b960f8
* Oat++ Server Generator (C++) * Fixed for support for newest OpenAPI version. * ALPHA not STABLE. * Fixed for support for newest OpenAPI version. * Added github workflow & changed to OA3 Petstore. * Good catch on adding the Workflow. * Might help to update the samples. * Set C++ Standard the CMake way. * Would be easier if there was a .pc file. * oatpp.lib. * Add ws2. * This probably doesn't work, need to take a time out.
47 lines
1.9 KiB
Markdown
47 lines
1.9 KiB
Markdown
# REST API Server for OpenAPI Petstore
|
|
|
|
## Overview
|
|
This API Server was generated by the [OpenAPI Generator](https://openapi-generator.tech) project.
|
|
It uses the [Oat++](https://github.com/oatpp/oatpp) Framework.
|
|
|
|
## Files organization
|
|
The Oat++ C++ REST server generator creates three folders:
|
|
- `api`: This folder contains the handlers for each method specified in the OpenAPI definition. Every handler extracts
|
|
the path and body parameters (if any) from the requests and tries to parse and possibly validate them.
|
|
Once this step is completed, the main API class calls the corresponding abstract method that should be implemented
|
|
by the developer (a basic implementation is provided under the `impl` folder)
|
|
- `impl`: As written above, the implementation folder contains, for each API, the corresponding implementation class,
|
|
which extends the main API class and implements the abstract methods.
|
|
Every method receives the path and body parameters as constant reference variables and a reference to the response
|
|
object, that should be filled with the right response and sent at the end of the method with the command:
|
|
response.send(returnCode, responseBody, [mimeType])
|
|
- `model`: This folder contains the corresponding class for every object schema found in the OpenAPI specification.
|
|
|
|
The main folder contains also a file with a main that can be used to start the server.
|
|
Of course, is you should customize this file based on your needs
|
|
|
|
## Installation
|
|
First of all, you need to download and install the libraries listed [here](#libraries-required).
|
|
|
|
Once the libraries are installed, in order to compile and run the server please follow the steps below:
|
|
```bash
|
|
mkdir build
|
|
cd build
|
|
cmake ..
|
|
make
|
|
```
|
|
|
|
Once compiled run the server:
|
|
|
|
```bash
|
|
cd build
|
|
./api-server
|
|
```
|
|
|
|
## Libraries required
|
|
- [Oat++](https://oatpp.io/)
|
|
|
|
## Namespaces
|
|
org.openapitools.server.api
|
|
org.openapitools.server.model
|