Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
O
OpenXG-AUSF
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Operations
Operations
Metrics
Environments
Analytics
Analytics
CI / CD
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
OpenXG
OpenXG-AUSF
Commits
13b237a0
Commit
13b237a0
authored
Feb 02, 2021
by
HFJ
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
fix readme
parent
d3f0f938
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
7 additions
and
20 deletions
+7
-20
README.md
README.md
+7
-20
No files found.
README.md
View file @
13b237a0
# REST API Server for AUSF API
# OpenXG-AUSF
## 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.
## Files organization
## 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
- `src/`: Source code and related external libs.
the path and body parameters (if any) from the requests and tries to parse and possibly validate them.
- `etc/`: Config file.
Once this step is completed, the main API class calls the corresponding abstract method that should be implemented
- `scripts/`: Build script.
by the developer (a basic implementation is provided under the
`impl`
folder)
- `README.md`: Installation guide.
-
`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
## Installation
### Install Libraries
### Install Libraries
```
bash
```
bash
sudo
apt-get
install
cmake git pkg-config nettle-dev libconfig++-dev libboost-all-dev curl libcurl4-gnutls-dev
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
sudo
apt-get
install
-y
build-essential
make
```
```
### Download the Souce Code
### Download the Souce Code
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment