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

2021-03-10 09:39:25 +08:00
 asanelder
java 写的 web 服务, 要给前端提供接口文档, 问下大家都是怎么生成的?
现在业内实践用的都是啥?
11399 次点击
所在节点    程序员
84 条回复
monkeyWie
2021-03-10 12:01:01 +08:00
swagger 然后自动同步到 yapi
scxiazi
2021-03-10 12:07:31 +08:00
restdoc
putaozhenhaochi
2021-03-10 12:16:20 +08:00
借楼问下，各位是先定义接口 还是先写代码
MarioLuo
2021-03-10 12:33:16 +08:00
YapiIdeaUploadPlugin IDEA 插件基于 JavaDoc 注释生成文档，上传到 yapi 中.
xnotepad
2021-03-10 13:05:58 +08:00
自己写了个 https://apidoc.tools
chogath
2021-03-10 13:25:13 +08:00
swagger + yapi，永远滴神
newmlp
2021-03-10 13:31:18 +08:00
md 手写
offswitch
2021-03-10 13:50:56 +08:00
@putaozhenhaochi 通常的说法是先写定义再写代码，不过大部分公司根本就没这要求，爱咋咋
alienx717
2021-03-10 13:57:36 +08:00
md 手写
XCFOX
2021-03-10 14:09:00 +08:00
目前用过最舒服的是 GraphQL 。文档和接口无缝结合。接口还是强类型的。前端能直接根据 graphql 接口地址生成接口类型
20200924
2021-03-10 14:18:37 +08:00
作为前端人员，感觉看 yapi 比看 swagger 舒服很多
justin2018
2021-03-10 14:44:07 +08:00
每次 API 有啥修改 就发一份 word 文档

真是 不好吐槽
54xavier
2021-03-10 14:44:36 +08:00
swagger
sannyzeng
2021-03-10 14:59:40 +08:00
yapi
fuyangyishi0
2021-03-10 15:02:23 +08:00
没人用 RAP 吗
Gunn27
2021-03-10 15:06:47 +08:00
https://apicat.net
guiling
2021-03-10 15:16:48 +08:00
yapi
qW7bo2FbzbC0
2021-03-10 15:23:28 +08:00
因为 go 没有便捷的 swagger 工具，我转 spring 这种插件成熟的框架了
yang2048
2021-03-10 15:39:03 +08:00
swagger 或者 knife4j
YadongZhang
2021-03-10 15:52:02 +08:00
RESTful API，只有我用 Postman 写文档吗。。。

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

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

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

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

© 2021 V2EX