|
2 | 2 |
|
3 | 3 | Example project how-to create basic CRUD endpoints and document them with Swagger-UI and OpenApi 3.0.0 |
4 | 4 |
|
5 | | -More about oat++: |
6 | | -- Website: [https://oatpp.io](https://oatpp.io) |
7 | | -- Docs: [https://oatpp.io/docs/start](https://oatpp.io/docs/start) |
8 | | -- Oat++ Repo: [https://github.com/oatpp/oatpp](https://github.com/oatpp/oatpp) |
| 5 | +See more: |
| 6 | + |
| 7 | +- [Oat++ Website](https://oatpp.io/) |
| 8 | +- [Oat++ Github Repository](https://github.com/oatpp/oatpp) |
| 9 | +- [Get Started](https://oatpp.io/docs/start) |
9 | 10 |
|
10 | 11 | ## Overview |
11 | | -This project is using `oatpp` and `oatpp-swagger` modules. |
| 12 | + |
| 13 | +This project is using [oatpp](https://github.com/oatpp/oatpp) and [oatpp-swagger](https://github.com/oatpp/oatpp-swagger) modules. |
12 | 14 |
|
13 | 15 | ### Project layout |
14 | 16 |
|
15 | 17 | ``` |
16 | | -- CMakeLists.txt // projects CMakeLists.txt |
17 | | -- src/ |
18 | | - | |
19 | | - |- controller/ // Folder containing UserController where all endpoints are declared |
20 | | - |- db/ // Folder with database mock |
21 | | - |- dto/ // DTOs are declared here |
22 | | - |- SwaggerComponent.hpp // Swagger-UI config |
23 | | - |- AppComponent.hpp // Service config |
24 | | - |- Logger.hpp // Application Logger |
25 | | - |- App.cpp // main() is here |
26 | | -
|
27 | | -- test/ // test folder |
28 | | -- utility/install-oatpp-modules.sh // utility script to install required oatpp-modules. |
29 | | - |
| 18 | +|- CMakeLists.txt // projects CMakeLists.txt |
| 19 | +|- src/ |
| 20 | +| | |
| 21 | +| |- controller/ // Folder containing UserController where all endpoints are declared |
| 22 | +| |- db/ // Folder with database mock |
| 23 | +| |- dto/ // DTOs are declared here |
| 24 | +| |- SwaggerComponent.hpp // Swagger-UI config |
| 25 | +| |- AppComponent.hpp // Service config |
| 26 | +| |- App.cpp // main() is here |
| 27 | +| |
| 28 | +|- test/ // test folder |
| 29 | +|- utility/install-oatpp-modules.sh // utility script to install required oatpp-modules. |
30 | 30 | ``` |
31 | 31 |
|
32 | 32 | --- |
|
0 commit comments