monitor_status/vendor/github.com/swaggo/gin-swagger/README.md

gin-swagger

gin middleware to automatically generate RESTful API documentation with Swagger 2.0.

Usage

Start using it

1. Add comments to your API source code, See Declarative Comments Format.

2. Download Swag for Go by using:

   $ go get github.com/swaggo/swag/cmd/swag
   

3. Run the Swag in your Go project root folder which contains main.go file, Swag will parse comments and generate required files(docs folder and docs/doc.go).

   $ swag init
   

   4.Download gin-swagger by using:

   $ go get -u github.com/swaggo/gin-swagger
   $ go get -u github.com/swaggo/gin-swagger/swaggerFiles
   

   And import following in your code:

import "github.com/swaggo/gin-swagger" // gin-swagger middleware
import "github.com/swaggo/gin-swagger/swaggerFiles" // swagger embed files

Canonical example:

package main

import (
	"github.com/gin-gonic/gin"
	"github.com/swaggo/gin-swagger"
	"github.com/swaggo/gin-swagger/swaggerFiles"

	_ "./docs" // docs is generated by Swag CLI, you have to import it.
)

// @title Swagger Example API
// @version 1.0
// @description This is a sample server Petstore server.
// @termsOfService http://swagger.io/terms/

// @contact.name API Support
// @contact.url http://www.swagger.io/support
// @contact.email support@swagger.io

// @license.name Apache 2.0
// @license.url http://www.apache.org/licenses/LICENSE-2.0.html

// @host petstore.swagger.io
// @BasePath /v2
func main() {
	r := gin.New()
    
    // use ginSwagger middleware to 
	r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))

	r.Run()
}

1. Run it, and browser to http://localhost:8080/swagger/index.html, you can see Swagger 2.0 Api documents.