Skip to content

Kachit/golang-api-skeleton

 
 

Repository files navigation

Golang Rest API skeleton

Build Status Codecov Go Report Card Version License

Uses:

  • gin as http framework
  • gorm-v2 as ORM
  • go-fractal as data transformer
  • go-hashids as numerical ID obfuscation

Commands list:

Command Description Launch
develop:test Testable command manually
database:migrations:migrate Apply migrations manually
database:migrations:rollback Rollback migrations manually
database:seeders:seed Seed dev data to DB manually
database:seeders:clear Clear dev data manually
app:start API WebServer launch manually

Launch

  • ./golang-api-skeleton {command} - simple launch
  • ./golang-api-skeleton {command} -config=./config.yml - launch with args

Testing

go test --coverprofile=coverage.out ./... && go tool cover -func coverage.out && go tool cover --html=coverage.out -o coverage.html

About

Base API skeleton to create applications with Golang.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Go 99.7%
  • Dockerfile 0.3%