Gin Adapter

The Gin adapter mounts open-swag-go documentation routes onto a Gin engine or route group. Gin is a high-performance HTTP framework with a martini-like API.

Installation

go get github.com/gopackx/open-swag-go/adapters/gin

Mount

Mount registers documentation routes on a Gin engine at the given path prefix.

main.go

package main
 
import (
	"github.com/gin-gonic/gin"
	openswag "github.com/gopackx/open-swag-go"
	swaggin "github.com/gopackx/open-swag-go/adapters/gin"
)
 
func main() {
	r := gin.Default()
 
	docs := openswag.New(openswag.Config{
		Info: openswag.Info{
			Title:   "My API",
			Version: "1.0.0",
		},
	})
 
	docs.Add(openswag.Endpoint{
		Method:  "GET",
		Path:    "/health",
		Summary: "Health check",
		Responses: openswag.Responses{
			200: {Description: "OK"},
		},
	})
 
	swaggin.Mount(r, docs, "/docs")
 
	r.Run(":8080")
}

MountGroup

MountGroup attaches documentation routes to a Gin RouterGroup. This is useful when you want to share middleware (e.g. authentication) across the docs routes.