Commit 13b237a0 authored by HFJ's avatar HFJ

fix readme

parent d3f0f938
# REST API Server for AUSF API
## Overview
This API Server was generated by the [OpenAPI Generator](https://openapi-generator.tech) project.
It uses the [Pistache](https://github.com/oktal/pistache) Framework.
# OpenXG-AUSF
## 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 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
```
- `src/`: Source code and related external libs.
- `etc/`: Config file.
- `scripts/`: Build script.
- `README.md`: Installation guide.
```
## Installation
### Install Libraries
```bash
sudo apt-get install cmake git pkg-config nettle-dev libconfig++-dev libboost-all-dev curl libcurl4-gnutls-dev
sudo apt-get install -y build-essential
make
```
### Download the Souce Code
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment