Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oatpp/example-postgresql
A complete example of a "CRUD" service (UserService) built with Oat++ and using oatpp ORM with PostgreSQL.
https://github.com/oatpp/example-postgresql
cpp microservices oatpp orm postgresql swagger-ui
Last synced: 3 months ago
JSON representation
A complete example of a "CRUD" service (UserService) built with Oat++ and using oatpp ORM with PostgreSQL.
- Host: GitHub
- URL: https://github.com/oatpp/example-postgresql
- Owner: oatpp
- License: apache-2.0
- Created: 2019-02-13T10:28:08.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-04-22T21:29:47.000Z (9 months ago)
- Last Synced: 2024-10-30T00:44:14.701Z (3 months ago)
- Topics: cpp, microservices, oatpp, orm, postgresql, swagger-ui
- Language: C++
- Homepage: https://oatpp.io/
- Size: 43.9 KB
- Stars: 38
- Watchers: 4
- Forks: 19
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - oatpp/example-postgresql - A complete example of a "CRUD" service (UserService) built with Oat++ and using oatpp ORM with PostgreSQL. (C++)
README
# example-postgresql [](https://dev.azure.com/lganzzzo/lganzzzo/_build/latest?definitionId=17&branchName=master)
A complete example of a "CRUD" service (UserService) built with Oat++ and using oatpp ORM with PostgreSQL.
In this example:
- How to create CRUD endpoints.
- How to use [oatpp ORM](https://oatpp.io/docs/components/orm/) - PostgreSQL example.
- How to document API with Swagger-UI and OpenApi 3.0.0.
More about Oat++:
- [Oat++ Website](https://oatpp.io/)
- [Oat++ Github Repository](https://github.com/oatpp/oatpp)
- [Get Started](https://oatpp.io/docs/start)
## Overview
This project is using the following oatpp modules:
- [oatpp](https://github.com/oatpp/oatpp)
- [oatpp-swagger](https://github.com/oatpp/oatpp-swagger)
- [oatpp-postgresql](https://github.com/oatpp/oatpp-postgresql)
### Project layout
```
|- CMakeLists.txt // projects CMakeLists.txt
|- src/
| |
| |- controller/ // Folder containing Controller where all endpoints are declared
| |- db/ // Folder containing the database client
| |- dto/ // DTOs are declared here
| |- service/ // Service business logic classes (UserService)
| |- ServiceComponent.hpp // Service configuration (port, ObjectMapper, Database)
| |- SwaggerComponent.hpp // Configuration for swagger-ui
| |- AppComponent.hpp // Service configuration is loaded here
| |- DatabaseComponent.hpp // Database config
| |- App.cpp // main() is here
|
|- test/ // test folder
|- utility/install-oatpp-modules.sh // utility script to install required oatpp-modules.
|- resources/config.json // configuration file with configuration profiles
|- Dockerfile // Dockerfile
|- docker-compose.yaml // Docker-compose with this service and postgresql
```
---
## Build and Run
### Using CMake
**Requires**
- This example also requires the PostgreSQL package installed.
- On Alpine `$ apk add postgresql-dev`
- On Ubuntu `$ apt-get install postgresql-server-dev-all`
For more info see [oatpp-postgresql/README.md](https://github.com/oatpp/oatpp-postgresql/blob/master/README.md)
- `oatpp`, `oatpp-swagger` and `oatpp-postgresql` modules installed. You may run `utility/install-oatpp-modules.sh`
script to install required oatpp modules.
```
$ mkdir build && cd build
$ cmake ..
$ make
$ ./example-postgresql-exe # - run application.
```
*PostgreSQL is expected running as for `dev` config profile*
### In Docker
#### Dockerfile
```
$ docker build -t example-postgresql .
$ docker run -p 8000:8000 -e CONFIG_PROFILE='dev' -t example-postgresql
```
#### docker-compose
```
$ docker-compose up
```
*docker-compose will run service with `local-docker` config profile*
### After run
Go to [http://localhost:8000/swagger/ui](http://localhost:8000/swagger/ui) to try endpoints.