mirror of
https://github.com/valitydev/openapi-generator.git
synced 2024-11-08 19:33:55 +00:00
23ab5177b3
* Added missing includes for optional * Removed shared pointer from pistache generator * Changed Net namespace to Pistache Namespace * Clean up code and removed unnecessary lines in mustache files * Removed remaining shared pointer syntax * Code review fixes + updated samples * Added const to all model setter functions, and reference to all params in setters that are not primitives * Refactored modelbase * Removed const * Updated samples |
||
---|---|---|
.. | ||
.openapi-generator | ||
api | ||
impl | ||
model | ||
.openapi-generator-ignore | ||
CMakeLists.txt | ||
PetApiMainServer.cpp | ||
README.md | ||
StoreApiMainServer.cpp | ||
UserApiMainServer.cpp |
REST API Server for OpenAPI Petstore
Overview
This API Server was generated by the OpenAPI Generator project. It uses the Pistache Framework.
Files organization
The Pistache 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 theimpl
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.
Once the libraries are installed, in order to compile and run the server please follow the steps below:
mkdir build
cd build
cmake ..
make
Once compiled run the server:
cd build
./server
Libraries required
- pistache
- JSON for Modern C++: Please download the
json.hpp
file and put it under the model folder
Namespaces
org.openapitools.server.api org.openapitools.server.model