This project implements APIs for cardholder and transaction management. It is built using golang and grpc. The APIs are defined using protobuf and the server is implemented using gRPC. The APIs are exposed using REST.
├── bin
│ ├── api
│ └── migration
├── cmd
│ ├── api
│ │ └── main.go
│ └── migration
│ └── main.go
├── deployment
│ ├── api.Dockerfile
│ └── migration.Dockerfile
├── docker-compose.yml
├── docs
│ └── openapiv2
│ └── protos
│ └── cardholder.swagger.json
│ └── transaction.swagger.json
│
├── internal
│ ├── app
│ │ ├── cardholder
│ │ └── transaction
│ └── mocks
│ ├── cardholder
│ └── transaction
├── Makefile
├── protos
├── README.md
└── rpcThe folder description for above structure is as follows:
| File/Folder | Description |
|---|---|
| bin | It contains the compiled binaries for this app |
| cmd | It contains the main applications for this app. Each application has its own subdirectory named after it. |
| deployment | It contains Dockerfiles. |
| docs | It contains the OpenAPI specification for the APIs (accounts and transactions) generated from the protobuf files. |
| internal | It contains the application code which is divided into different modules like app,config,db and mocks. |
| protos | It contains the Protobuf definitions for the APIs (accounts and transactions). |
| rpc | It contains the generated code from the Protobuf definitions. |
- Docker
- Docker-compose
Build the docker images using the docker-compose file
docker-compose buildRun the docker-compose setup
docker-compose upYou can generate the open api spec for the existing apis using the following:
# This downloads the dependencies and generates openapi spec
make setupIt will be generated under docs/openapiv2/protos folder.
The APIs can be accessed using the following postman link:
Postman link: link
docker-compose -f docker-compose-testing.yml up