Build Status codecov Go Report Card

Golang-swaggerui-example is an example repository for setting up API documentation using SwaggerUI in your Golang project. Detailed instruction is available on my blog.

API Interaction

SwaggerUI is accessible via accessing localhost:8080/swaggerui/ Detailed explanation on how to serve /swaggerui is explained in THIS blog post.


Swagger.json should not be in your git repository, instead it should be generated by a CI tool.

The code provided here doesn’t follow any standards. It is intended only to demonstrate go-swagger spec generation in a simple go project. Do not use this project structure/implementation as a reference for your Golang REST projects.


golang-swaggerui-example is licensed under the MIT license. Check the LICENSE file for details.


Soul Friend


View Github