主要有两个场景：1.团队内部使用； 2.接口文档导出给第三方对接平台
• 请不要在回答技术问题时复制粘贴 AI 生成的内容
This topic created in 1598 days ago, the information mentioned may be changed or developed.
 |
iamfei666Jun 28, 2022
1
语雀
|
 |
dayeye2006199Jun 28, 2022
2
注释
|
 |
yekernJun 28, 2022
3
Apifox 或者 Apipost 直接调试 然后网页访问文档 还能加密
|
 |
THESDZJun 28, 2022
4
个人建议是找个支持 openapi(swagger3)导入的框架
|
1 |
mengdodoJun 28, 2022
6
showdoc
|
 |
oypJun 28, 2022
7
直接手写 Word
|
 |
waisingJun 28, 2022
8
手动录入 yapi
|
|
oypJun 28, 2022
9
我用 wolai 编辑 API 文档，不用想那么多，写起来贼流畅。虽然不能直接运行（我手动运行一样的）和不能自动生成结构（把返回的数据粘贴过去，看 JSO 也能看出来，没必要生成）
图 1：s3.bmp.ovh/imgs/2022/06/28/7334b6845b8fd612.png 图 2：s3.bmp.ovh/imgs/2022/06/28/7e83681e49b8c241.png |
 |
xuxuzhaozhaoJun 28, 2022
10
非常推荐使用 ApiPost
|
 |
DavidDeeJun 28, 2022
11
yapi,rap2
|
 |
jmllx1963Jun 28, 2022
12
apifox 可以通过 URL 直接导入 openAPI3 的接口和数据模型 还是很方便的
|
 |
abc0123xyzJun 28, 2022
13
别写什么文档注释，提高竞争力，防止被优化（狗头）
|
 |
carrie96Jun 28, 2022
14
yapi ？ swagger ？
|
 |
d119Jun 28, 2022
15
postman 不也可以吗
|
 |
linaurorJun 28, 2022
16
个人目前用的比较爽的是用注释导出 swagger ，然后 yapi 自动定时同步 swagger.json （手工导入会导致结构错乱，不知道咋回事）
|
 |
ychostJun 28, 2022
17
ApiPost 好用，还能一键生成 HTML/Markdown 文档，唯一不爽的就是老是在更新！
|
 |
flowerainsJun 28, 2022
18
Apifox ，apiPost
但是从团队协作的程度上来看我觉得 eolink 更有潜力 |
 |
wolfieJun 28, 2022
19
showdoc ，导出不太方便（可能版本问题）。/t/842583
_都不用 ApiPost ，可以搜一搜过去在 v2 上的恶心推广。 |
 |
balabalagugujiJun 28, 2022
20
不废话，看效果先： https://easydoc.net/s/17790664/CZMqMhfW/78558034
还可以做手册，自定义域名，看效果： https://k8s.easydoc.net 官网： https://easydoc.net |
 |
jayinJun 28, 2022
21
apifox
|
 |
southsalaJun 28, 2022
22
月经贴，能选择的就那么几个，yapi 、swagger 、showdoc 、apifox
|
|
balabalagugujiJun 28, 2022
23
@southsala #22 你不试下易文档，个人觉得比你说的这几个都好太多了
|
 |
guanhui07Jun 28, 2022
24
yapi 、swagger 、showdoc 、apifox
|
 |
2696284032Jun 28, 2022
25
eolink 是我用过最好用的
|
 |
26
强推 swagger+postman.
swagger 非常方便本地调试，如果团队一起维护一个 postman ，说实话体验是真的不错。 在大型系统中用 postman 的话比单纯使用 swagger 要舒服，正式环境我会关闭 swagger ，使用 postman 调。apipost 和 apifox 我都用过，公司也掏钱了，实际体验并没有 postman 丝滑，可能和我个人习惯有关系。 语雀和 wolai 都是在线的文档，考虑到隐私性我放弃了使用。 |
 |
v2ebJun 28, 2022 via Android
27
knif4j
|
 |
xsenJun 28, 2022
28
yapi
|
 |
sutraJun 28, 2022
29
|
 |
nekonekoJun 28, 2022
30
showdoc
不能自己部署服务端的接口文档工具都是垃圾 |
 |
ixinshangJun 28, 2022
31
showdoc
|
 |
SaxtonJun 28, 2022
32
Apifox 一直在用，缺点就是每个版本新加的功能很多，但改动也很大
|
 |
CathayChenJun 28, 2022
33
|
 |
alen0206Jun 28, 2022
34
yapi
|
 |
securityCodingJun 28, 2022 via Android
35
pb
|
 |
jeffhJun 28, 2022
36
必须 yapi ，搭配 idea 插件，神一般的存在
|
|
linaurorJun 29, 2022
38
@gclm 如果你用的 golang 的话，可以结合 swaggo ，直接引用结构体和注释来生成 swagger.json ，其他语言应该也有类似的生成工具
|
 |
wm5d8bJun 29, 2022 via Android
40
接口文档工具默认就是 HTTP 吗，dubbo 和 grpc 的怎么维护
|
 |
howaworldJul 7, 2022
41
apipost 不错，尤其对新手来说，很容易上手，我带的新人一下午就能搞明白。
|
 |
scarqinNov 14, 2022
42
开源接口工具 Eoapi ，可本地部署
|
 |
jchnxuAug 28, 2023
43
@oyp 我们倒是做了一个 MVP 出来，可以 [直接运行] ，目前也是 [纯本地] 的。应该就是你说的这样。https://union.anyscript.dev/
@legiorange 也想请你来试一试。我们的感觉是，用页面的组织方式，可能比 postman 的那种 collection workspace 方式更 灵活 openapi spec 这种我们倒是也可以支持。不过还是想先看看，这样去组织 api 或者跑脚本，到底有没有人用 |
Select Language