goweb如何使用swagger自动化文档

如何自动化文档,做api接口

阅读 5.8k
2 个回答

我现在是在后端生成的文档,在http函数上面加注解的方式
github 地址 https://github.com/yvasiyarov...
比如:

/*
@Title 测试swagger
@Description 测试swagger
@Accept  json
@Param   limit    query    int64   false    "limit"
@Param   page     query    int64   false    "page"
@Resource test
@Router /test/swagger [GET]
*/
func HttpTestSwagger(ctx echo.Context) error {
    limit := ctx.QueryParam("limit")
    page := ctx.QueryParam("page")

    fmt.Println(limit, "  ", page)

    return helper.SuccessResponse(ctx, "")
}

执行swagger的生成文档命令,会生成swagger目录和文件

然后你就可以把访问地址执行生成的文档上就行了

beego也带这种注解式的swagger 文档生成,缺陷是路由只支持namespace那种形式的

撰写回答
你尚未登录,登录后可以
  • 和开发者交流问题的细节
  • 关注并接收问题和回答的更新提醒
  • 参与内容的编辑和改进,让解决方法与时俱进