当前位置：网站首页>焕然一新，swagger UI 主题更改

焕然一新，swagger UI 主题更改

2022-07-29 05:19:00 【廖圣平】

swagger UI 比较让人头疼的就是项目大了之后，接口很难找到。偶然看到了一个UI库还是不错，能搜索接口名，而且整个布局也相对比较人性化
在这里插入图片描述

项目地址

可以集成到自己的swagger项目中，以Golang为例：

替换一下渲染的方法即可：

	//r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler)) //注释掉之前的渲染方式，访问即可
	r.GET("/swagger/*any", handleReDoc)

func handleReDoc(ctx *gin.Context) {
    
	i := strings.LastIndex(ctx.Request.URL.Path, "/")
	if i == -1 {
    
		return
	}
	suffix := ctx.Request.URL.Path[i+1:]
	switch suffix {
    
	case "doc.json":
		// 载入swag生成的 docs/swagger.json
		data, err := ioutil.ReadFile("docs/swagger.json")
		if err != nil {
    
			panic("cannot open docs/swagger.json")
		}

		_, _ = ctx.Writer.Write(data)
		return
	case "index.html":
		// 这个index.html咱们得从ReDoc的github主页上拿
		// spec-url是swagger.json的URL，要改为当前项目的
		const redocIndexHTML = `<!DOCTYPE html> <html> <head> <title>ReDoc换皮成功</title> <!-- needed for adaptive design --> <meta charset="utf-8"/> <meta name="viewport" content="width=device-width, initial-scale=1"> <link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet"> <!-- ReDoc doesn't change outer page styles --> <style> body { margin: 0; padding: 0; } </style> </head> <body> <redoc spec-url='http://127.0.0.1:8080/swagger/doc.json'></redoc> <script src="https://cdn.jsdelivr.net/npm/[email protected]/bundles/redoc.standalone.js"> </script> </body> </html>`
		fmt.Println("ererer")
		_, _ = ctx.Writer.Write([]byte(redocIndexHTML))
		return
	default:
		_ = ctx.AbortWithError(http.StatusNotFound, errors.New("page not found"))
	}

在这里插入图片描述

原网站

版权声明
本文为[廖圣平]所创，转载请带上原文链接，感谢
https://liaosp.blog.csdn.net/article/details/121906719

边栏推荐

猜你喜欢

随机推荐