An boielrplate of REST API server using following tools.
- SQLBoiler for ORM
- oapi-codegen for REST API Interface
This repository is an addendum of this post.
https://future-architect.github.io/articles/20210730a/
- air: Run the server with hot reloading.
- PostgreSQL server
If you are opening this project via VSCode Remote Container, these tools are already configured in docker-compose.yml
.
├── boiler # Generated codes by SQLBoiler
├── restapi # Generated codes by oapi-codegen
├── sql # Database table definitions
├── openapi.yml # REST API definitions
├── cmd
│ └── server # Run server
├── app.go # Server implementation
├── db.go # Database configurations
├── middleware.go # net/http middlewares
├── event.go # Select/Insert data from/to the database with types defined in REST API specs.
└── user.go
Regenerate code when you modify following codes.
sql/*.sql: Database table definitions.openapi.yml: API definitions.
make clean
make generate
go mod tidy
air
Environment variables
DB_URL: Database URL. Defaults connect to the container running in Remote Container service.