go-rest-api-aml-service
Go (Golang) API REST with Gin Framework
1. Project Description
- Build REST APIs to support AML service with the support of external third party.
- Setup github actions to run testcases
- Support microservices
- JWT authentication
- Secret Manager
2. Run with Docker
- Build
make build
docker build . -t api-rest
- Run
docker-compose up
or
docker run -p 3000:3000 api-rest
- Test
go test -v ./test/...
3. Generate Docs
# Get swag go 1.16 or newer
go install github.com/swaggo/swag/cmd/swag@latest
# Get swag go bellow 1.16
go get -u github.com/swaggo/swag/cmd/swag
# Generate docs
swag init --dir cmd/api --parseDependency --output docs
or Make sure to import the generated docs/docs.go so that your specific configuration gets init'ed. If your General API annotations do not live in main.go, you can let swag know with -g flag.
swag init -g http/api.go
3. Docs and References
- Swaggo official docs https://github.com/swaggo/swag
- Run and go to http://localhost:3000/docs/index.html
