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

2021-03-10 09:39:25 +08:00
 asanelder
java 写的 web 服务, 要给前端提供接口文档, 问下大家都是怎么生成的?
现在业内实践用的都是啥?
11399 次点击
所在节点    程序员
84 条回复
salenpeng
2021-03-10 15:57:22 +08:00
swag /:狗头
hakr
2021-03-10 16:07:14 +08:00
@YadongZhang #60 俺也用...
freebird1994
2021-03-10 16:17:52 +08:00
swagger + yapi
liuw666
2021-03-10 16:45:54 +08:00
写 protobuf 然后生成 swagger
liuw666
2021-03-10 16:47:59 +08:00
使用 protobuf 定义，只要想改接口参数，proto 就必须修改，swagger 肯定也是最新的
ERRASYNCTYPE
2021-03-10 17:20:09 +08:00
实习生写
asanelder
2021-03-10 17:32:09 +08:00
@ERRASYNCTYPE #66 铁子, nb
m1ch3ng
2021-03-10 18:32:51 +08:00
smart-doc，靠 javadoc 就能自动生成
liuzhihang
2021-03-10 19:22:57 +08:00
IDEA 插件 Doc View 纯 markdown 。不知道能不能满足你的需求。也欢迎 v2 小伙伴提 PR

https://github.com/liuzhihang/doc-view

![aF2vk5-L5pmGt]( https://cdn.jsdelivr.net/gh/liuzhihang/oss/pic/article/aF2vk5-L5pmGt.png)
Cbdy
2021-03-10 19:37:33 +08:00
手写
liuzhihang
2021-03-10 19:51:11 +08:00
发不出来图…… 看链接吧 https://plugins.jetbrains.com/plugin/15305-doc-view
noyidoit
2021-03-10 20:02:41 +08:00
postman......
dcatfly
2021-03-10 21:54:48 +08:00
yapi 竟然有 1k+的 issue 没关闭，最近在用它内部的组件，代码写的一言难尽。。让我觉得这个项目还没死也是不容易。。
vfxx
2021-03-10 21:55:19 +08:00
@star7th 必须推荐 showdoc，用过的都说好。
ArrayBuffer
2021-03-11 09:15:55 +08:00
我是前端, 对我来说最好的还是 `swagger` / `graphql`; `swagger` 是比较成熟的, 但对于阅读者来说还是有些地方体验不是很好, 为此我写了个脚本 greasyfork.org/zh-CN/scripts/401581, `graphql` 我也写了 greasyfork.org/zh-CN/scripts/416677
xcatliu
2021-03-11 09:34:59 +08:00
Swagger UI 感觉不是很好看，有没有其他替代？（除了 yapi ）
feitxue
2021-03-11 09:54:18 +08:00
swagger 增强 ui 后的 knife4j,会舒服一点.
zaul
2021-03-11 14:53:14 +08:00
语雀
balabalaguguji
2021-03-11 18:01:11 +08:00
@xcatliu #76 易文档可以看下，真好用
balabalaguguji
2021-03-11 18:02:15 +08:00
@vfxx #74 那肯定还没用过易文档

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

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

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

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

© 2021 V2EX