求推荐比较好用的接口文档管理工具?

2022-06-28 08:43:02 +08:00
 zhuwd
主要有两个场景:1.团队内部使用; 2.接口文档导出给第三方对接平台
6584 次点击
所在节点    程序员
43 条回复
iamfei666
2022-06-28 08:47:40 +08:00
语雀
dayeye2006199
2022-06-28 08:51:39 +08:00
注释
yekern
2022-06-28 08:54:50 +08:00
Apifox 或者 Apipost 直接调试 然后网页访问文档 还能加密
THESDZ
2022-06-28 08:57:00 +08:00
个人建议是找个支持 openapi(swagger3)导入的框架
THESDZ
2022-06-28 08:58:27 +08:00
@THESDZ
优势是:1.代码即文档,减少工作量。2.标准格式外部工具很多,例如导出 word ,pdf ,markdown ;生成 sdk 等。
mengdodo
2022-06-28 09:00:16 +08:00
showdoc
oyp
2022-06-28 09:00:31 +08:00
直接手写 Word
waising
2022-06-28 09:02:55 +08:00
手动录入 yapi
oyp
2022-06-28 09:04:24 +08:00
我用 wolai 编辑 API 文档,不用想那么多,写起来贼流畅。虽然不能直接运行(我手动运行一样的)和不能自动生成结构(把返回的数据粘贴过去,看 JSO 也能看出来,没必要生成)

图 1:s3.bmp.ovh/imgs/2022/06/28/7334b6845b8fd612.png
图 2:s3.bmp.ovh/imgs/2022/06/28/7e83681e49b8c241.png
xuxuzhaozhao
2022-06-28 09:05:19 +08:00
非常推荐使用 ApiPost
DavidDee
2022-06-28 09:12:52 +08:00
yapi,rap2
jmllx1963
2022-06-28 09:13:33 +08:00
apifox 可以通过 URL 直接导入 openAPI3 的接口和数据模型 还是很方便的
abc0123xyz
2022-06-28 09:13:54 +08:00
别写什么文档注释,提高竞争力,防止被优化(狗头)
carrie96
2022-06-28 09:14:41 +08:00
yapi ? swagger ?
d119
2022-06-28 09:27:04 +08:00
postman 不也可以吗
linauror
2022-06-28 09:27:31 +08:00
个人目前用的比较爽的是用注释导出 swagger ,然后 yapi 自动定时同步 swagger.json (手工导入会导致结构错乱,不知道咋回事)
ychost
2022-06-28 09:29:54 +08:00
ApiPost 好用,还能一键生成 HTML/Markdown 文档,唯一不爽的就是老是在更新!
flowerains
2022-06-28 09:32:37 +08:00
Apifox ,apiPost

但是从团队协作的程度上来看我觉得 eolink 更有潜力
wolfie
2022-06-28 09:33:58 +08:00
showdoc ,导出不太方便(可能版本问题)。/t/842583

_都不用 ApiPost ,可以搜一搜过去在 v2 上的恶心推广。
balabalaguguji
2022-06-28 09:34:20 +08:00
不废话,看效果先: https://easydoc.net/s/17790664/CZMqMhfW/78558034
还可以做手册,自定义域名,看效果: https://k8s.easydoc.net

官网: https://easydoc.net

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

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

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

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

© 2021 V2EX