Documentation ¶
Overview ¶
Package ginHelper brings convenience to development with gin.
Automatically generate swagger documents without comments.
Index ¶
Examples ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var GenHandlerFunc gin.HandlerFunc = nil
Functions ¶
Types ¶
type BaseParam ¶ added in v0.1.0
type BaseParam struct { }
type ContactInfoProps ¶ added in v0.1.0
type ContactInfoProps spec.ContactInfoProps
type GinRouter ¶ added in v0.1.0
type GinRouter interface { gin.IRoutes Group(relativePath string, handlers ...gin.HandlerFunc) *gin.RouterGroup BasePath() string }
type GroupRouter ¶ added in v0.1.0
type Helper ¶ added in v0.1.0
type Helper struct { Swagger *Swagger // contains filtered or unexported fields }
func NewWithSwagger ¶ added in v0.1.0
func NewWithSwagger(swaggerInfo *SwaggerInfo, r GinRouter) *Helper
Example ¶
router := gin.Default() r := router.Group("api") h := NewWithSwagger(&SwaggerInfo{ Description: "swagger test page", Title: "Swagger Test Page", Version: "0.0.1", ContactInfoProps: ContactInfoProps{ Name: "zzj", URL: "https://zzj.cool", Email: "email@zzj.cool", }, }, r) h.Add(exGroup, r) _ = router.Run(":12321")
Output:
func (*Helper) Add ¶ added in v0.1.0
func (h *Helper) Add(gh *GroupRouter, r GinRouter)
type Route ¶ added in v0.1.0
type Route struct { Param Parameter // 接口的参数 Path string // 接口的路径 Method string // 接口的方法 Summary string // 接口说明 Handlers []gin.HandlerFunc // 接口的处理函数 }
func (*Route) AddHandler ¶ added in v0.1.0
type Swagger ¶ added in v0.1.0
type Swagger struct { BasePath string Router GinRouter *SwaggerInfo Spec *spec.Swagger }
func (*Swagger) AddPath ¶ added in v0.1.0
func (s *Swagger) AddPath(sp *SwaggerApi)
type SwaggerApi ¶ added in v0.1.0
type SwaggerInfo ¶ added in v0.1.0
type SwaggerInfo struct { Description string Title string Version string ContactInfoProps }
Click to show internal directories.
Click to hide internal directories.