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

[v2dev]

主要有两个场景：1.团队内部使用； 2.接口文档导出给第三方对接平台

[iamfei666]

语雀

[dayeye2006199]

注释

[yekern]

Apifox 或者 Apipost 直接调试 然后网页访问文档 还能加密

[THESDZ]

个人建议是找个支持 openapi(swagger3)导入的框架

[THESDZ]

@THESDZ
优势是：1.代码即文档，减少工作量。2.标准格式外部工具很多，例如导出 word ，pdf ，markdown ；生成 sdk 等。

[mengdodo]

showdoc

[oyp]

直接手写 Word

[waising]

手动录入 yapi

[oyp]

我用 wolai 编辑 API 文档，不用想那么多，写起来贼流畅。虽然不能直接运行（我手动运行一样的）和不能自动生成结构（把返回的数据粘贴过去，看 JSO 也能看出来，没必要生成）

图 1：s3.bmp.ovh/imgs/2022/06/28/7334b6845b8fd612.png
图 2：s3.bmp.ovh/imgs/2022/06/28/7e83681e49b8c241.png

[xuxuzhaozhao]

非常推荐使用 ApiPost

[DavidDee]

yapi,rap2

[jmllx1963]

apifox 可以通过 URL 直接导入 openAPI3 的接口和数据模型 还是很方便的

[abc0123xyz]

别写什么文档注释，提高竞争力，防止被优化（狗头）

[carrie96]

yapi ？ swagger ？

[d119]

postman 不也可以吗

[linauror]

个人目前用的比较爽的是用注释导出 swagger ，然后 yapi 自动定时同步 swagger.json （手工导入会导致结构错乱，不知道咋回事）

[ychost]

ApiPost 好用，还能一键生成 HTML/Markdown 文档，唯一不爽的就是老是在更新！

[flowerains]

Apifox ，apiPost

但是从团队协作的程度上来看我觉得 eolink 更有潜力

[wolfie]

showdoc ，导出不太方便（可能版本问题）。/t/842583

_都不用 ApiPost ，可以搜一搜过去在 v2 上的恶心推广。

[balabalaguguji]

不废话，看效果先： https://easydoc.net/s/17790664/CZMqMhfW/78558034
还可以做手册，自定义域名，看效果： https://k8s.easydoc.net

官网： https://easydoc.net

[jayin]

apifox

[southsala]

月经贴，能选择的就那么几个，yapi 、swagger 、showdoc 、apifox

[balabalaguguji]

@southsala #22 你不试下易文档，个人觉得比你说的这几个都好太多了

[guanhui07]

yapi 、swagger 、showdoc 、apifox

[2696284032]

eolink 是我用过最好用的

[legiorange]

强推 swagger+postman.
swagger 非常方便本地调试，如果团队一起维护一个 postman ，说实话体验是真的不错。
在大型系统中用 postman 的话比单纯使用 swagger 要舒服，正式环境我会关闭 swagger ，使用 postman 调。apipost 和 apifox 我都用过，公司也掏钱了，实际体验并没有 postman 丝滑，可能和我个人习惯有关系。
语雀和 wolai 都是在线的文档，考虑到隐私性我放弃了使用。

[v2eb]

knif4j

[xsen]

yapi

[sutra]

https://github.com/stoicflame/enunciate

[nekoneko]

showdoc
不能自己部署服务端的接口文档工具都是垃圾

[ixinshang]

showdoc

[Saxton]

Apifox 一直在用，缺点就是每个版本新加的功能很多，但改动也很大

[CathayChen]

https://apidocjs.com/

[alen0206]

yapi

[securityCoding]

pb

[jeffh]

必须 yapi ，搭配 idea 插件，神一般的存在

[gclm]

@linauror 如何用注解生成 swagger.json 啊，能否分享一下呢？目前感觉你这个方法很棒

[linauror]

@gclm 如果你用的 golang 的话，可以结合 swaggo ，直接引用结构体和注释来生成 swagger.json ，其他语言应该也有类似的生成工具

[cubecube]

@THESDZ 很多接口并不能用 openapi 表示呢

[wm5d8b]

接口文档工具默认就是 HTTP 吗，dubbo 和 grpc 的怎么维护

[howaworld]

apipost 不错，尤其对新手来说，很容易上手，我带的新人一下午就能搞明白。

[scarqin]

开源接口工具 Eoapi ，可本地部署

[jchnxu]

@oyp 我们倒是做了一个 MVP 出来，可以 [直接运行] ，目前也是 [纯本地] 的。应该就是你说的这样。https://union.anyscript.dev/

@legiorange 也想请你来试一试。我们的感觉是，用页面的组织方式，可能比 postman 的那种 collection workspace 方式更 灵活

openapi spec 这种我们倒是也可以支持。不过还是想先看看，这样去组织 api 或者跑脚本，到底有没有人用