Skip to content

tiancheng92/gin-swagger

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

28 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

gin-swagger (swagger-ui版本:v4.10.0)

  • 为减小包体积,删除了swagger-ui中的Source Map文件,仅保留必要的图标、js、css文件。
  • 使用了golang 1.16 的新特性 File Embed,取代原swaggo/gin-swagger使用的webdav
  • 预计比原swaggo/gin-swagger内存占用少35M+

用法

  1. 下载 Swag
$ go get -u github.com/swaggo/swag/cmd/swag
  1. 初始化 Swag
$ swag init
  1. 下载 gin-swagger
$ go get -u github.com/tiancheng92/gin-swagger
  1. 代码中引入
import "github.com/tiancheng92/gin-swagger"

实例

package main

import (
	"github.com/gin-gonic/gin"
	ginSwagger "github.com/tiancheng92/gin-swagger"

	_ "./docs"
)

// @title Swagger Example API
// @version 1.0
// @BasePath /api
func main() {
	r := gin.New()
	r.GET("/swagger/*any", ginSwagger.WrapHandler())
	r.Run()
}

注意

  1. golang版本必须大于等于1.16.0