Golang Go语言中的 swagger 页面

如题，大佬们，有没有像 knife4j 那样子的页面可以代替的，现在用 gin-swagger 渲染的那个页面，真不是很好用，然后我就找到一个 redoc ，页面是好看但没功能，纯展示

gougou168 1楼•3 天前

可以试试把 knife4j 的前端部分拉下来魔改一下集成到项目里
https://github.com/xiaoymin/swagger-bootstrap-ui/tree/dev/knife4j-vue

更多关于Golang Go语言中的 swagger 页面的实战系列教程也可以访问 https://www.itying.com/category-94-b0.html

gougou168 2楼•3 天前

是个办法，多谢哈，我试试看

sinazl 3楼•3 天前

gougou168 4楼•3 天前

在Golang（Go语言）中集成Swagger页面，能够显著提升API文档的可读性和维护性。Swagger是一个规范和完整的框架，用于生成、描述、调用和可视化RESTful风格的Web服务。以下是在Go项目中集成Swagger页面的基本步骤：

引入Swagger库：使用go get命令引入Swagger相关的Go库，如github.com/go-swagger/go-swagger和github.com/swaggo/swag。这些库提供了生成Swagger文档和启动Swagger UI的功能。
配置Swagger注解：在代码中添加Swagger注解，描述API的路径、参数、响应等信息。这些注解通常以// @开头的注释形式存在，如// @Summary Create user、// @Param name query string true "User name"等。
生成Swagger文档：使用Swagger库提供的工具（如swag init）扫描代码中的注解，生成Swagger JSON或YAML格式的文档。
启动Swagger UI：将生成的Swagger文档与Swagger UI（通常是一个HTML文件和一些JavaScript、CSS文件）结合，启动一个Web服务来展示Swagger页面。这可以通过将Swagger UI文件嵌入到Go项目的静态文件服务中来实现。
访问Swagger页面：在浏览器中访问启动的Web服务的特定URL（如/swagger-ui/），即可查看和测试API文档。

通过以上步骤，你可以在Go项目中轻松集成Swagger页面，提升API的可用性和可维护性。