|
1 | 1 | # Async API Example [](https://dev.azure.com/lganzzzo/lganzzzo/_build?definitionId=16&branchName=master)
|
2 | 2 |
|
3 |
| -Example project how-to use oatpp asynchronous API. |
| 3 | +Example project how-to use oat++ (AKA oatpp) asynchronous API. |
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 | 12 |
|
12 | 13 | ### Project layout
|
13 | 14 |
|
14 | 15 | ```
|
15 |
| -- CMakeLists.txt // projects CMakeLists.txt |
16 |
| -- src/ |
17 |
| - | |
18 |
| - |- controller/ // Folder containing controller where all endpoints are declared |
19 |
| - |- dto/ // DTOs are declared here |
20 |
| - |- AppComponent.hpp // Service config |
21 |
| - |- Logger.hpp // Application Logger |
22 |
| - |- App.cpp // main() is here |
23 |
| -
|
24 |
| -- test/ // test folder |
25 |
| -- utility/install-oatpp-modules.sh // utility script to install required oatpp-modules. |
26 |
| - |
| 16 | +|- CMakeLists.txt // projects CMakeLists.txt |
| 17 | +|- src/ |
| 18 | +| | |
| 19 | +| |- controller/ // Folder containing controller where all endpoints are declared |
| 20 | +| |- dto/ // DTOs are declared here |
| 21 | +| |- AppComponent.hpp // Service config |
| 22 | +| |- App.cpp // main() is here |
| 23 | +| |
| 24 | +|- test/ // test folder |
| 25 | +|- utility/install-oatpp-modules.sh // utility script to install required oatpp-modules. |
27 | 26 | ```
|
28 | 27 |
|
29 | 28 | ---
|
@@ -51,3 +50,10 @@ $ ./example-async-api-exe # - run application.
|
51 | 50 | $ docker build -t example-async-api .
|
52 | 51 | $ docker run -p 8000:8000 -t example-async-api
|
53 | 52 | ```
|
| 53 | + |
| 54 | +## Read More |
| 55 | + |
| 56 | +- [Simple API vs Async API](https://oatpp.io/docs/simple-vs-async/) |
| 57 | +- [Async](https://oatpp.io/docs/async/) |
| 58 | +- [Oatpp-Coroutines](https://oatpp.io/docs/oatpp-coroutines/) |
| 59 | +- [ENDPOINT_ASYNC](https://oatpp.io/docs/components/api-controller/#endpoint-async-specifics) |
0 commit comments