Golang REST API

Go RESTful API with PostgreSQL and Docker.

Preparing to launch a project

• Install Docker

Install & Run

# download this project
git clone https://github.com/esmira23/go-postgresql-docker.git

cd go-postgresql-docker
# build and run docker-compose
docker compose up -d --build
#API http:/localhost:8080/

Project tree

├── db/migration                        // migration for database
│   ├── 000001_init_schema.down.sql
│   └── 000001_init_schema.up.sql
├── docs                                // swagger
│   ├── docs.go
│   ├── swagger.json
│   └── swagger.yaml
├── config
│   └── config.go                       // configuration for database
├── controllers
│   └── controller.go                   // controllers for application
├── csvparser
│   ├── csvparser.go                    // csv parser
│   └── example.csv                     // csv data
├── routers
│   └── router.go                       // routers for application
├── models
│   └── model.go                        // models for application
├── docker-compose.yml                  // docker compose file
├── Dockerfile                          // Dockerfile
├── main_test.go                        // unit tests
└── main.go

API

Method	Path	Description
POST	/api/post_data	Post all data
GET	/api/all	Get all data
GET	/api/transaction/:id	Get data by transaction id
GET	/api/terminal?id=id_1,id_2,..,id_n	Get data by terminal id (allow several ids)
GET	/api/status/:status	Get data by status (accepted/declined)
GET	/api/payment_type/:type	Get data by payment type (cash/card)
GET	/api/date?from=date_from&to=date_to	Get data by date_post by periods (from/to)
GET	/api/payment_narrative/:narrative	Get data by partially payment_narrative

{•••} Swagger API

Go to API Docs page: http://localhost:8080/swagger/index.html

Run all the Unit test cases

go test -v

Tasks

• Parse *.csv file and save result to the database.
• Filter and upload data in JSON format in the response:
  • search by transaction_id
  • search by terminal_id (possibility of specifying several ids)
  • search by status (accepted/declined)
  • search by payment_type (cash/card)
  • search by date_post by periods (from/to)
  • search on the partially specified payment_narrative
• Use relational database: PostgreSQL.
• API documentation.
• Use docker and docker-compose.
• Implement the unit test.