-
Notifications
You must be signed in to change notification settings - Fork 98
/
swagger.go
63 lines (52 loc) · 2.06 KB
/
swagger.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
// Package swagger is gin swagger library.
package swagger
import (
"fmt"
"os"
"strings"
"github.com/gin-gonic/gin"
swaggerFiles "github.com/swaggo/files"
ginSwagger "github.com/swaggo/gin-swagger"
"github.com/swaggo/swag"
"github.com/zhufuyi/sponge/pkg/gofile"
)
// DefaultRouter default swagger router, request url is http://<ip:port>/swagger/index.html
func DefaultRouter(r *gin.Engine, jsonContent []byte) {
registerSwagger("swagger", jsonContent)
r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))
}
// DefaultRouterByFile default swagger router from file, request url is http://<ip:port>/swagger/index.html
func DefaultRouterByFile(r *gin.Engine, jsonFile string) {
jsonContent, err := os.ReadFile(jsonFile)
if err != nil {
fmt.Printf("\nos.ReadFile error: %v\n\n", err)
return
}
registerSwagger("swagger", jsonContent)
r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))
}
// CustomRouter custom swagger routing, request url is http://<ip:port>/<name>/swagger/index.html
func CustomRouter(r *gin.Engine, name string, jsonContent []byte) {
registerSwagger(name, jsonContent)
r.GET(fmt.Sprintf("/%s/swagger/*any", name), ginSwagger.WrapHandler(swaggerFiles.NewHandler(), ginSwagger.InstanceName(name)))
}
// CustomRouterByFile custom swagger router from file, request url is http://<ip:port>/<filename prefix>/swagger/index.html
func CustomRouterByFile(r *gin.Engine, jsonFile string) {
jsonContent, err := os.ReadFile(jsonFile)
if err != nil {
fmt.Printf("\nos.ReadFile error: %v\n\n", err)
return
}
filename := gofile.GetFilename(jsonFile)
name := strings.Split(filename, ".")[0]
registerSwagger(name, jsonContent)
r.GET(fmt.Sprintf("/%s/swagger/*any", name), ginSwagger.WrapHandler(swaggerFiles.NewHandler(), ginSwagger.InstanceName(name)))
}
func registerSwagger(infoInstanceName string, jsonContent []byte) {
swaggerInfo := &swag.Spec{
Schemes: []string{"http", "https"},
InfoInstanceName: infoInstanceName,
SwaggerTemplate: string(jsonContent),
}
swag.Register(swaggerInfo.InstanceName(), swaggerInfo)
}