API 文档大家是怎么生成的?

2021-03-10 09:39:25 +08:00
 asanelder
java 写的 web 服务, 要给前端提供接口文档, 问下大家都是怎么生成的?
现在业内实践用的都是啥?
10965 次点击
所在节点    程序员
84 条回复
alanhe421
2021-03-10 09:41:47 +08:00
swagger
sunziren
2021-03-10 09:49:18 +08:00
用过楼上的，挺好的
gageshan
2021-03-10 09:49:53 +08:00
https://github.com/YMFE/yapi
knightdf
2021-03-10 09:50:51 +08:00
openapi, swagger
wolfie
2021-03-10 09:51:31 +08:00
md 手写，生成的除了自己很难看，而且涉及到字段改动怎么标注。
lungank
2021-03-10 09:52:14 +08:00
swagger
rationa1cuzz
2021-03-10 09:55:15 +08:00
难道就我一个人手写吗？
hanssx
2021-03-10 09:56:48 +08:00
如果 python 的话，fastapi 很不错。
zlhsvc
2021-03-10 09:56:55 +08:00
手写，之前用过脚本总觉得差了点
yiqiao
2021-03-10 09:57:06 +08:00
swagger 能够快速生成。
showdoc
acmore
2021-03-10 09:57:33 +08:00
swagger
Java 生态下也可以考虑 Spring Rest Docs
balabalaguguji
2021-03-10 09:59:25 +08:00
可以用易文档编写 https://easydoc.xyz ，它也可以一键生成文档，也可以从注释生成文档。预览效果： https://www.easydoc.xyz/s/17790664

截图
https://i.loli.net/2021/03/10/jVQdKMkJ4FPevui.png
liuzhaowei55
2021-03-10 10:01:18 +08:00
手写
bigpigeon
2021-03-10 10:03:12 +08:00
swagger
bigpigeon
2021-03-10 10:04:09 +08:00
写了一个通过 go 框架生成 swagger 代码的 api，只要实现 api 就能自动生成 swagger
SjwNo1
2021-03-10 10:06:49 +08:00
手写+1
sss495088732
2021-03-10 10:10:15 +08:00
yapi docker 手写
jowan
2021-03-10 10:14:20 +08:00
swag
zhaorunze
2021-03-10 10:16:42 +08:00
我还以为手写了个框架，仔细一想，可能是手写文档。。。
ghouleztt
2021-03-10 10:19:02 +08:00
swagger

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

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

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

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

© 2021 V2EX