https://github.com/fzdwx/swgin

Help gin users generate swagger when defining routes
https://github.com/fzdwx/swgin

gin swagger

Last synced: 1 day ago
JSON representation

Help gin users generate swagger when defining routes

• Host: GitHub
• URL: https://github.com/fzdwx/swgin
• Owner: fzdwx
• License: mit
• Created: 2023-09-10T14:32:10.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-09-10T14:49:56.000Z (over 1 year ago)
• Last Synced: 2024-11-14T14:41:29.992Z (3 months ago)
• Topics: gin, swagger
• Language: Go
• Homepage:
• Size: 17.6 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Swgin

Help gin users generate swagger when defining routes

Install

```shell

go get github.com/fzdwx/swgin

```

Usage

```go

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

	}

}

```