ui

README

// example 
engine := gin.Default()
// app
appFizz := fizz.NewFromEngine(engine)
appInfos := &openapi.Info{
   Title:       "Fruits Market",
   Description: `This is a sample Fruits market server.`,
   Version:     "1.0.0",
}
appFizz.GET("/app/openapi.json", nil, appFizz.OpenAPI(appInfos, "json"))

// h5
h5Fizz := fizz.NewFromEngine(engine)
h5Infos := &openapi.Info{
   Title:       "Fruits Market",
   Description: `This is a sample Fruits market server.`,
   Version:     "1.0.0",
}
h5Fizz.GET("/h5/openapi.json", nil, h5Fizz.OpenAPI(h5Infos, "json"))

// add a OpenApi UI with groups
ui.AddUIGroupHandler(engine, "/doc", ui.SwaggerUrl{
		Name: "app",
		Url:  "/app/openapi.json",
	}, ui.SwaggerUrl{
		Name: "H5",
		Url:  "/h5/openapi.json",
	})

And then you can get a api document with ui like follows

Documentation

Index

• func AddUIGroupHandler(ginEngine gin.IRoutes, path string, groups ...SwaggerUrl)
• func AddUIHandler(ginEngine gin.IRoutes, path string, openApiJsonPath string)
• type SwaggerConfig
• type SwaggerUrl

Functions

func AddUIGroupHandler

func AddUIGroupHandler(ginEngine gin.IRoutes, path string, groups ...SwaggerUrl)

AddUIGroupHandler adds handler that serves html for Swagger UI

func AddUIHandler

func AddUIHandler(ginEngine gin.IRoutes, path string, openApiJsonPath string)

AddUIHandler adds handler that serves html for Swagger UI

Types

type SwaggerConfig

type SwaggerConfig struct {
	ConfigUrl              string        `json:"configUrl"`
	DisplayRequestDuration bool          `json:"displayRequestDuration"`
	Oauth2RedirectUrl      string        `json:"oauth2RedirectUrl"`
	OperationsSorter       string        `json:"operationsSorter"`
	ValidatorUrl           string        `json:"validatorUrl"`
	Urls                   *[]SwaggerUrl `json:"urls"`
}

type SwaggerUrl

type SwaggerUrl struct {
	Url  string `json:"url"`
	Name string `json:"name"`
}