Gloang Swagger
2024-09-06 18:33:56
功能
自动生产接口文档
安装
# 安装swag
go get -u github.com/swaggo/swag/cmd/swag
# 安装 gin-swagger
go get -u github.com/swaggo/gin-swagger
go get -u github.com/swaggo/gin-swagger/swaggerFiles
编写API注释
例1-新增
// @Summary 新增文章标签
// @Produce json
// @Param name query string true "Name"
// @Param state query int false "State"
// @Param created_by query string false "CreatedBy"
// @Success 200 {object} app.Response
// @Success 500 {object} app.Response
// @Router /api/tags [post]
func AddTag(c *gin.Context) {
...
}
例2-编辑
// @Summary 编辑文章标签
// @Produce json
// @Param id path int true "ID"
// @Param name query string true "Name"
// @Param state query int false "State"
// @Param modified_by query string false "ModifiedBy"
// @Success 200 {object} app.Response
// @Success 500 {object} app.Response
// @Router /api/tags/{id} [put]
func EditTag(c *gin.Context) {
...
}
参数格式说明
@Param state query int false "State"
@Params 实际参数 query/path 类型 是否必须 别名
路由中初始化
package routers import (
... _ "your_module_name/docs" ...
) // InitRouter initialize routing information
func InitRouter() *gin.Engine {
...
r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))
... return r
}
生成
在项目根目录执行
swag init
执行完后,生成
获取在线接口文档
http://127.0.0.1:8000/swagger/index.html
最新文章
- Android自定义控件之自定义ViewGroup实现标签云
- Windows Phone 五、配置存储
- xampp出现 Access forbidden! 问题解决
- .Net的Excel 导出 格式设置
- TOGAF培训讲义
- ios证书
- 用FireBreath制作浏览器插件
- Entity Framework学习笔记(六)----使用Lambda查询Entity Framework(1)
- java中如何调用oracle存储过程
- 深刻理解iosBlock
- Linux压缩打包tar命令总结
- 4.2、LED1、LED2交替闪烁
- 修改ini文件的批处理
- spring boot 跨域请求
- 面试真题-----hashMap原理
- 敲代码非常难之logstash之file input插件实现分析
- 我的成长比价系列:java web开发过程中遇到的错误一:sql语句换行错误
- 【CF888G】Xor-MST(最小生成树,Trie树)
- Spark在Windows下的环境搭建
- windows过滤指定IP