go-rest-template

module
v0.0.0-...-089f0e8 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 2, 2022 License: MIT

README

go-rest-template

Go (Golang) API REST Template/Boilerplate with Gin Framework

Go Report Card Open Source Love Build Status

1. Run with Docker

  1. Build
make build
docker build . -t api-rest
  1. Run
docker run -p 3000:3000 api-rest
  1. Test
go test -v ./test/...

2. Generate Docs

# Get swag
go get -u github.com/swaggo/swag/cmd/swag

# Generate docs
swag init --dir cmd/api --parseDependency --output docs

Run and go to http://localhost:3000/docs/index.html

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL