swag

README

#Swagger

Introduction to API documentation

OpenAPI

Swagger

Lets create Swagger doc for your API

1. Install GoSwagger (swagger manual tutorial)
2. Add proper tags to your code comments {meta, route, params, response, model, etc.}
3. Launch generate spec
4. Launch swagger UI swagger npm or use online
5. Make test calls to your API

Related: add static file, Swagger for Node.js

Documentation

Overview

Package classification Petstore API.

the purpose of this application is to provide an application that is using plain go code to define an API

This should demonstrate all the possible comment annotations that are available to turn go code into a fully compliant swagger 2.0 spec

Terms Of Service:

there are no TOS at this moment, use at your own risk we take no responsibility

Schemes: http, https
Host: localhost
BasePath: /v2
Version: 0.0.1
License: MIT http://opensource.org/licenses/MIT
Contact: John Doe<john.doe@example.com> http://john.doe.com

Consumes:
- application/json
- application/xml

Produces:
- application/json
- application/xml

swagger:meta