注解的方式生成 swagger 文档太麻烦，有没有 Go 模块类似 Python FastAPI 的自动生成文档的机制？

[DoctorCat]

[xuanbg]

手写 MD 文档就不麻烦了，复制-粘贴改一改就好，效率飞起

[qW7bo2FbzbC0]

用 c# 或者 spring 多好，django 的 swagger 都不是很方便，因为这个原因弃用 go 做 web 服务

[charmToby]

同求，有类似机制的，楼主记得艾特我。

[lingxi27]

换种思路，文档->代码

[DoctorCat]

@lingxi27
@xuanbg

要的就是 swagger 在线发请求的测试功能，回到原始 doc 上那当然就不会有这个问题了…建议我手写 doc 仿佛在跟我说蒸汽机不好搞，还是继续坐马车吧 🤦‍♂️

[DoctorCat]

@hjahgdthab750 Python 的话 FastAPI 可以自动生成，不需要人肉介入。

[qW7bo2FbzbC0]

@DoctorCat #6 fastapi 不能像 flask django 那样直接用 py 文件启动吧，好像要在系统上装什么来着

[qW7bo2FbzbC0]

@hjahgdthab750 #7 没有超级用户权限，我选择绕开 fastapi，本来还是挺不错的项目

[TangMonk]

Ruby 的 grape 配合 swagger 异常好用，全自动生成，连注释都不写

[haitaotao]

如果是 api 的建议先使用 protobuf 等 idl 描述，再动生成文档和代码。

我们也是苦文档不更新久矣。最后搞了个[sniper 框架]( https://github.com/bilibili/sniper)，具体的设计思路可以参考[这篇文章]( https://zhuanlan.zhihu.com/p/69029677)。在生产环境跑了两年多了，效果还不错。

[charmToby]

@hjahgdthab750 FastAPI 只需要安装 uvicorn 就可以直接 py 文件启动了。

[wzw]

https://github.com/gogf/swagger
我用了
https://goframe.org/index

[qW7bo2FbzbC0]

@charmToby #11 对对，线上没有 uvicorn，也没有安装的权限

[siteshen]

有几年没用 go 了，看到这个话题，回顾一下在 go 项目中使用 swagger 历程。
注：我也一直讨厌写不必要的 API 文档，尤其是 API 输入、输出格式等本应该能自动生成的文档。

1. 最初是自己写的代码，根据 request, response 对象生成 swagger.json 文件（ python 也自己写过……）：
https://www.v2ex.com/t/390148?p=1#r_4746014
2. 后来某个项目使用过 https://github.com/MarkSonghurst/swag （印象中某些 feature 支持不够好，我还改过少量代码）
3. 另外看到其他 v 友选择过 https://github.com/Tencent/APIJSON，也许以后会尝试？
https://v2ex.com/t/556593?p=2#r_7208890

[reus]

学习下标准库里 go/ast go/types 几个包，自己写一个就行，一两百行完事的程序，自己需要什么就写什么，何必到处找，你找到也未必合用。

[herofire]

smartdoc?

[Biebe]

用 protobuf 描述借口，protoc swagger 插件自动生成

[tiedan]

protobuf

[lingxi27]

@DoctorCat

你可能没完全明白我的意思，要不看看这个能不能帮到你

[lingxi27]

@DoctorCat

https://github.com/go-swagger/go-swagger