Go Web 集成swagger

钟艾伶

已于 2022-05-09 17:10:29 修改

阅读量3k

点赞数 1

分类专栏：【Go】文章标签： go swagger api

于 2019-07-19 17:29:09 首次发布

本文链接：https://blog.youkuaiyun.com/Daybreak1209/article/details/96484713

版权

本文介绍了如何在Go项目中使用swaggo来集成并自动生成RESTful API接口文档，避免手动编写面向wiki的编程。主要分为三个步骤：下载swaggo资源，将swaggo集成到gin框架的web工程中，通过注解编写接口文档，并通过swag init命令生成Swagger UI页面，最后访问http://localhost:12343/swagger/index.html查看清晰明了的API详情。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

swagger 完美API文档的生成工具，免去繁琐的面向wiki编程。java中可直接引用swagger依赖，spring全家桶对swagger也集成通过写注解便可直接生成入参返回值的api接口文档。go项目也有对应的swaggo集成。下面介绍如何在go工程中使用swaggo自动生成接口文档。很简单，三步走

一、项目download swaggo资源

//1.安装swag client

go get -u github.com/swaggo/swag/cmd/swag

# 2.gin-swagger 中间件

$ go get github.com/swaggo/gin-swagger

# 3.swagger 内置文件

$ go get github.com/swaggo/gin-swagger/swaggerFiles

二、go web工程集成swaggo

1. gin router 处添加如下代码（拦截器操作）

r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))

2.简单举例，更新接口api接口处添加注释，注意按如下注解编写注释

// @Summary 编辑系统用户

// @Description 编辑系统用户 账号、角色不予更新；只更新密码和姓名

// @Tags 系统用户模块

// @Param userName formData string true "账号"

// @Param password formData string false "密码"

// @Param realName formData string true "用户姓名"

// &

最低0.47元/天解锁文章