swgin

README

Swgin

Help gin users generate swagger when defining routes

Install

go get github.com/fzdwx/swgin

Usage

type Req struct {
	Name string `json:"name"`
	Age  int    `json:"age"`
	List []Item `json:"list"`
}

type Item struct {
	Java   string `json:"java"`
	Golang string `json:"golang"`
}

func main() {

	e := gin.New()
	s := swgin.New(e)

	s.Router(swgin.Router{
		Method:  "Get",
		Path:    "hello",
		Summary: "测试 hello",
		Body:    Req{},
		Handlers: []gin.HandlerFunc{
			func(context *gin.Context) {

			},
		},
	})

	o := s.Parse()

	bytes, err := json.Marshal(o)
	if err != nil {
		return
	}

	err = os.WriteFile("swagger.json", bytes, 0644)
	if err != nil {
		return
	}
}

Documentation

Index

• Variables
• type Router
• type RouterGroup
• type Swgin
  • func New(e *gin.Engine) *Swgin
  • func (s *Swgin) Group(rg RouterGroup) *Swgin
  • func (s *Swgin) Parse() swaggerObject
  • func (s *Swgin) Router(r Router) *Swgin

Variables

var (
	PropertiesNameJson  = "json"
	PropertiesNameQuery = "query"

	RequiredName = "required"
)

Types

type Router

type Router struct {
	Path        string
	Method      string
	Summary     string
	Description string

	Tags         []string
	Query        any
	Body         any
	ResponseType any

	Handlers []gin.HandlerFunc

	// extended properties
	Properties map[string]string
}

type RouterGroup

type RouterGroup struct {
	Path    string
	Routers []Router
}

type Swgin

type Swgin struct {
	Title       string
	Version     string
	Description string
	Host        string
	BasePath    string
	// contains filtered or unexported fields
}

func New

func New(e *gin.Engine) *Swgin

func (*Swgin) Group

func (s *Swgin) Group(rg RouterGroup) *Swgin

func (*Swgin) Parse

func (s *Swgin) Parse() swaggerObject

func (*Swgin) Router

func (s *Swgin) Router(r Router) *Swgin