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

2020-11-26 13:08:41 +08:00
 DoctorCat
4991 次点击
所在节点    Go 编程语言
42 条回复
Rwing
2020-11-26 16:01:19 +08:00
考虑下 c#,直接把代码注释生成 swagger 😊
janxin
2020-11-26 16:30:28 +08:00
zqx
2020-11-26 16:35:16 +08:00
先写文档,再开发,就不慢了
DoctorCat
2020-11-26 16:38:22 +08:00
@lingxi27 我们理解的“自动”这项能力,不是同一种,我要的是不需要写代码注释的生成框架。

@reus 你的提议很好,不过我就是想先看看有没有可以百白嫖的代码
yuan434356430
2020-11-26 16:42:37 +08:00
用 javaparser 静态分析代码,自动生成 Swagger 注解,我这么写过,不过只是生成了简单一点的,因为有些字段和方法是没有注释的
yuan434356430
2020-11-26 16:44:14 +08:00
因为 swagger 的注解内容都是可以从已有的代码里读取到的
DoctorCat
2020-11-26 16:44:24 +08:00
@siteshen 不太喜欢 APIJSON 接管 ORM
siteshen
2020-11-26 16:56:17 +08:00
@DoctorCat 我用 go 写 API,没用过 framework,都是用的 library,自己手写 model + generate 通用的 model 级别的 API 。
听你这么说 APIJSON 还会接管 ORM,应该是 framework 了。
meshell
2020-11-26 17:01:08 +08:00
用 go 我还是建议手写 markdown....
sprite82
2020-11-26 17:30:17 +08:00
推荐个 apifox 功能方面挺好的,mock swagger,压测 都有,但是貌似有 cpu 占用的问题,如果有安全要求的话就别用了
DoctorCat
2020-11-26 17:31:49 +08:00
@siteshen APIJSON ? 可能我不太熟这个操作。
jiyingze
2020-11-26 18:13:13 +08:00
smart-doc 可以根据源码注释生成文档。
DoctorCat
2020-11-26 20:05:16 +08:00
@jiyingze 你确定说的是支持 Go 语言的产物?
saberlong
2020-11-26 22:35:28 +08:00
我也是用 golang 自带 ast 针对性写的
lidashuang
2020-11-27 11:49:23 +08:00
lidashuang
2020-11-27 11:49:47 +08:00
@charmToby Graphql 也可以考虑
lidashuang
2020-11-27 11:50:02 +08:00
@meshell 手写 你不累吗
meshell
2020-11-27 12:00:04 +08:00
@lidashuang 还好呀。说实话,go 里面写注释,然后生成还没有手写 markdown 复制粘贴快.
TransAM
2020-11-27 12:44:13 +08:00
python 不写 docstr 能自动生成文档?开玩笑
joesonw
2020-11-27 13:12:50 +08:00
go 自带 ast 包, 随便怎么玩代码生成啊.

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/729447

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX