Skip to content

Commit e01f517

Browse files
committed
Merge branch 'master' of github.com:oatpp/example-async-api
2 parents fbcaa27 + 00db643 commit e01f517

File tree

1 file changed

+23
-17
lines changed

1 file changed

+23
-17
lines changed

README.md

Lines changed: 23 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,28 @@
11
# Async API Example [![Build Status](https://dev.azure.com/lganzzzo/lganzzzo/_apis/build/status/oatpp.example-async-api?branchName=master)](https://dev.azure.com/lganzzzo/lganzzzo/_build?definitionId=16&branchName=master)
22

3-
Example project how-to use oatpp asynchronous API.
3+
Example project how-to use oat++ (AKA oatpp) asynchronous API.
44

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)
910

1011
## Overview
1112

1213
### Project layout
1314

1415
```
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.
2726
```
2827

2928
---
@@ -51,3 +50,10 @@ $ ./example-async-api-exe # - run application.
5150
$ docker build -t example-async-api .
5251
$ docker run -p 8000:8000 -t example-async-api
5352
```
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

Comments
 (0)