example-postgresql

Example of a production grade entity service storing information in PostgreSQL. With Swagger-UI and configuration profiles.
Libpq is used to communicate with PostgreSQL database.
Dockerfile and docker-compose.yaml files included.

More about oat++:

Website: https://oatpp.io
Docs: https://oatpp.io/docs/start
Oat++ Repo: https://github.com/oatpp/oatpp

Overview

This project is using oatpp and oatpp-swagger modules.

Project layout


|- CMakeLists.txt               // project loader script. load and build dependencies 
|- main/                        // main project directory
|    |
|    |- CMakeLists.txt          // project's CMakeLists.txt
|    |- src/                    // source folder
|    |- test/                   // test folder
|    |- resources/
|         |
|         |- config.json        // configuration file with configuration profiles
|
|- Dockerfile                   // Dockerfile
|- docker-compose.yaml          // Docker-compose with this service and postgresql

- src/
    |
    |- controller/              // Folder containing Controller where all endpoints are declared
    |- db/                      // Database class is here 
    |- dto/                     // DTOs are declared here
    |- ServiceComponent.hpp     // Service configuration (port, ObjectMapper, Database)
    |- SwaggerComponent.hpp     // Configuration for swagger-ui
    |- AppComponent.hpp         // Service configuration is loaded here
    |- Logger.hpp               // Application Logger
    |- App.cpp                  // main() is here

Build and Run

Using CMake

Requires libpq installed. To install libpq:

On Mac $ brew install libpq
On Alpine $ apk add postgresql-dev
On Ubuntu - goto Install PostgreSQL Client From Sources

$ mkdir build && cd build
$ cmake ..
$ make run        ## Download, build, and install all dependencies. Run project

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 to try endpoints.

Install PostgreSQL Client From Sources

Download sources from https://www.postgresql.org/ftp/source/

$ wget https://ftp.postgresql.org/pub/source/v11.1/postgresql-11.1.tar.gz

Untar
```
$ tar -xvzf postgresql-11.1.tar.gz
```

CD to postgresql-11.1, configure, make:

$ cd postgresql-11.1
$ ./configure
$ make

Install PostgreSQL client-only
For this particular example we don't need full PostgreSQL installation.
```
$ make -C src/include install 
$ make -C src/interfaces install
```

For more information see PostgreSQL installation guide

ezhangle / example-postgresql Goto Github PK