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

2021-03-10 09:39:25 +08:00
 asanelder
java 写的 web 服务, 要给前端提供接口文档, 问下大家都是怎么生成的?
现在业内实践用的都是啥?
11399 次点击
所在节点    程序员
84 条回复
Molita
2021-03-10 10:20:22 +08:00
swagger 然后 用 redoc 展示
15190049162
2021-03-10 10:20:45 +08:00
swagger+插件直接变 doc
mcfog
2021-03-10 10:28:27 +08:00
重要的不是怎么生成，而是数据源在哪里，怎么管理
h82258652
2021-03-10 10:29:44 +08:00
swagger，部分生成不了的用 docfx
oneend
2021-03-10 10:32:23 +08:00
只有我用 gitbook 吗？
www5070504
2021-03-10 10:34:11 +08:00
swagger 只要增加几行注释 很好用..
a62527776a
2021-03-10 10:36:22 +08:00
apidoc
Rekkles
2021-03-10 10:36:49 +08:00
yapi
star7th
2021-03-10 10:37:34 +08:00
https://github.com/star7th/showdoc
journalistFromHK
2021-03-10 10:48:07 +08:00
上一家公司，老板写 java，啥是文档？不存在的，自己去看 controller 吧
so1n
2021-03-10 10:49:02 +08:00
自己写了一个库来自动生成 https://github.com/so1n/pait
henryhu
2021-03-10 11:18:24 +08:00
apidoc
UN2758
2021-03-10 11:20:37 +08:00
@hanssx #8 我记得 fastapi 用的也是 swagger
KisekiRemi
2021-03-10 11:21:41 +08:00
对接的给我一个 swagger
cat007
2021-03-10 11:25:34 +08:00
swagger+yapi
AngryPanda
2021-03-10 11:27:09 +08:00
md 手写 、YAPI
evam
2021-03-10 11:31:20 +08:00
postman 自己调试接口，然后 postman 分享，coding 自动生成
egfegdfr
2021-03-10 11:39:48 +08:00
smart-doc
感觉 swagger 的侵入性太强了
jorneyr
2021-03-10 11:41:09 +08:00
不喜欢 swagger 这种污染源码的工具，更喜欢用 yApi 这种类似的工具进行管理。
xuanbg
2021-03-10 11:54:45 +08:00
@wolfie md 手写+1，也就是模版上面复制粘贴，一点都不费事。swagger 实在是太丑

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

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

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

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

© 2021 V2EX