1
iamfei666 2022-06-28 08:47:40 +08:00
语雀
|
2
dayeye2006199 2022-06-28 08:51:39 +08:00
注释
|
3
yekern 2022-06-28 08:54:50 +08:00
Apifox 或者 Apipost 直接调试 然后网页访问文档 还能加密
|
4
THESDZ 2022-06-28 08:57:00 +08:00
个人建议是找个支持 openapi(swagger3)导入的框架
|
5
THESDZ 2022-06-28 08:58:27 +08:00 1
@THESDZ
优势是:1.代码即文档,减少工作量。2.标准格式外部工具很多,例如导出 word ,pdf ,markdown ;生成 sdk 等。 |
6
mengdodo 2022-06-28 09:00:16 +08:00
showdoc
|
7
oyp 2022-06-28 09:00:31 +08:00
直接手写 Word
|
8
waising 2022-06-28 09:02:55 +08:00
手动录入 yapi
|
9
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 |
10
xuxuzhaozhao 2022-06-28 09:05:19 +08:00
非常推荐使用 ApiPost
|
11
DavidDee 2022-06-28 09:12:52 +08:00
yapi,rap2
|
12
jmllx1963 2022-06-28 09:13:33 +08:00
apifox 可以通过 URL 直接导入 openAPI3 的接口和数据模型 还是很方便的
|
13
abc0123xyz 2022-06-28 09:13:54 +08:00
别写什么文档注释,提高竞争力,防止被优化(狗头)
|
14
carrie96 2022-06-28 09:14:41 +08:00
yapi ? swagger ?
|
15
d119 2022-06-28 09:27:04 +08:00
postman 不也可以吗
|
16
linauror 2022-06-28 09:27:31 +08:00
个人目前用的比较爽的是用注释导出 swagger ,然后 yapi 自动定时同步 swagger.json (手工导入会导致结构错乱,不知道咋回事)
|
17
ychost 2022-06-28 09:29:54 +08:00
ApiPost 好用,还能一键生成 HTML/Markdown 文档,唯一不爽的就是老是在更新!
|
18
flowerains 2022-06-28 09:32:37 +08:00
Apifox ,apiPost
但是从团队协作的程度上来看我觉得 eolink 更有潜力 |
19
wolfie 2022-06-28 09:33:58 +08:00
showdoc ,导出不太方便(可能版本问题)。/t/842583
_都不用 ApiPost ,可以搜一搜过去在 v2 上的恶心推广。 |
20
balabalaguguji 2022-06-28 09:34:20 +08:00
不废话,看效果先: https://easydoc.net/s/17790664/CZMqMhfW/78558034
还可以做手册,自定义域名,看效果: https://k8s.easydoc.net 官网: https://easydoc.net |
21
jayin 2022-06-28 09:46:20 +08:00
apifox
|
22
southsala 2022-06-28 09:54:00 +08:00
月经贴,能选择的就那么几个,yapi 、swagger 、showdoc 、apifox
|
23
balabalaguguji 2022-06-28 09:56:14 +08:00
@southsala #22 你不试下易文档,个人觉得比你说的这几个都好太多了
|
24
guanhui07 2022-06-28 11:19:38 +08:00
yapi 、swagger 、showdoc 、apifox
|
25
2696284032 2022-06-28 11:20:55 +08:00
eolink 是我用过最好用的
|
26
legiorange 2022-06-28 11:24:04 +08:00 1
强推 swagger+postman.
swagger 非常方便本地调试,如果团队一起维护一个 postman ,说实话体验是真的不错。 在大型系统中用 postman 的话比单纯使用 swagger 要舒服,正式环境我会关闭 swagger ,使用 postman 调。apipost 和 apifox 我都用过,公司也掏钱了,实际体验并没有 postman 丝滑,可能和我个人习惯有关系。 语雀和 wolai 都是在线的文档,考虑到隐私性我放弃了使用。 |
27
v2eb 2022-06-28 12:32:22 +08:00 via Android
knif4j
|
28
xsen 2022-06-28 12:39:39 +08:00
yapi
|
29
sutra 2022-06-28 13:08:01 +08:00
|
30
nekoneko 2022-06-28 16:47:59 +08:00
showdoc
不能自己部署服务端的接口文档工具都是垃圾 |
31
ixinshang 2022-06-28 16:50:23 +08:00
showdoc
|
32
Saxton 2022-06-28 16:52:25 +08:00
Apifox 一直在用,缺点就是每个版本新加的功能很多,但改动也很大
|
33
CathayChen 2022-06-28 17:22:56 +08:00
|
34
alen0206 2022-06-28 17:23:46 +08:00
yapi
|
35
securityCoding 2022-06-28 17:43:02 +08:00 via Android
pb
|
36
jeffh 2022-06-28 23:18:36 +08:00
必须 yapi ,搭配 idea 插件,神一般的存在
|
38
linauror 2022-06-29 09:29:35 +08:00
@gclm 如果你用的 golang 的话,可以结合 swaggo ,直接引用结构体和注释来生成 swagger.json ,其他语言应该也有类似的生成工具
|
40
wm5d8b 2022-06-29 13:17:26 +08:00 via Android
接口文档工具默认就是 HTTP 吗,dubbo 和 grpc 的怎么维护
|
41
howaworld 2022-07-07 20:10:17 +08:00
apipost 不错,尤其对新手来说,很容易上手,我带的新人一下午就能搞明白。
|
42
scarqin 2022-11-14 09:42:57 +08:00
开源接口工具 Eoapi ,可本地部署
|
43
jchnxu 2023-08-28 16:24:19 +08:00
@oyp 我们倒是做了一个 MVP 出来,可以 [直接运行] ,目前也是 [纯本地] 的。应该就是你说的这样。https://union.anyscript.dev/
@legiorange 也想请你来试一试。我们的感觉是,用页面的组织方式,可能比 postman 的那种 collection workspace 方式更 灵活 openapi spec 这种我们倒是也可以支持。不过还是想先看看,这样去组织 api 或者跑脚本,到底有没有人用 |