go-api-hack

README

GO-API-HACK

Blog Posts - More Information About This Repo

You can find more information about this project/repository and how to use it in following bl

• Setting Up Swagger Docs for Golang API

Setting Up

• Replace All Occurrences of eftakhairul/go-api-hack/cmd with your username repository name
• Replace All Occurrences of blueprint with your desired image name

Adding New Libraries/Dependencies

go mod vendor

Setup CodeClimate

• Go to https://codeclimate.com/github/repos/new
• Add Repository
• Go to Test Coverage Tab
• Copy Test Reporter ID
• Go to Travis and Open Settings for Your Repository
• Add Environment Variable: name: CC_TEST_REPORTER_ID, value: Copied from CodeClimate

Swagger

• Application uses gin-swagger.
• To generate/update docs use swag init (from /go-project-blueprint/cmd/blueprint)
• You can find generated docs in docs package

To view docs, navigate to http://localhost:1234/swagger/index.html or to http://localhost:1234/swagger/doc.json for raw JSON