求推荐接口文档管理开源项目

V2EX = way to explore

V2EX 是一个关于分享和探索的地方

现在注册

已注册用户请登录

• 请不要在回答技术问题时复制粘贴 AI 生成的内容

这是一个创建于 1593 天前的主题，其中的信息可能已经有所发展或是发生改变。

目前了解的有 RAP2 、Yapi，这两个产品都在本地都跑了下，发现 YApi 比较符合需求，想问问大家还有其他的推荐吗？

最好是支持以下特性：

项目组以及权限管理
支持导入 swagger.json
支持在线调试接口

31 条回复 • 2021-09-10 13:30:29 +08:00

gba

2020-08-13 12:23:24 +08:00 via Android

网易 NEI

x537196

2020-08-13 12:29:23 +08:00

魔改 showdoc

mylxsw

2020-08-13 12:34:01 +08:00 via iPhone

wizard，同时支持 markdown 和 swagger 。

https://github.com/mylxsw/wizard

AngryPanda

2020-08-13 13:02:48 +08:00 via Android

yapi

monkeyWie

2020-08-13 13:31:31 +08:00

@gba 这个不支持私有部署吗

vvmint233

2020-08-13 13:54:36 +08:00

redoc

gba

2020-08-13 14:25:45 +08:00

https://github.com/x-orpheus/nei 我看官网提供的项目地址，里面有部署方式。不过我没试过，一直用在线的。。

johnsona

2020-08-13 14:28:23 +08:00

yapi 再加一票，swagger 阳光下的泡沫

monkeyWie

2020-08-13 15:03:16 +08:00

@gba 好吧，不支持 swagger 导入，还是放弃了

wangyzj

2020-08-13 15:05:48 +08:00

yapi

monkeyWie

2020-08-13 15:11:06 +08:00

@mylxsw 哇作者本人啊，我测试了下 wizard，设计非常棒，但是有一个缺点就是集成的原生的 swagger UI 太难用了，因为不支持按 tag 导航，建议导入 swagger 的时候自动把 tag 作为子菜单导入，然后 UI 的话可以考虑移植 knife4J，比原生的好用多了，谢谢~

monkeyWie

2020-08-13 15:11:55 +08:00

@AngryPanda
@jsisjs20130824
@wangyzj
我也觉得是 yapi yes 了🤣

byzf

2020-08-13 18:15:05 +08:00

wiki.js 有人用过不, 貌似功能上差点意思.

star7th

2020-08-13 21:47:17 +08:00

一个非常适合 IT 团队的在线 API 文档、技术文档工具 github.com/star7th/showdoc

star7th

2020-08-13 21:48:12 +08:00

另外接口调试的话，配合这个工具使用 www.showdoc.com.cn/runapi?page_id=30291

xsen

2020-08-13 21:54:00 +08:00

yapi +1

hangszhang

2020-08-13 22:58:53 +08:00

去哪儿网 yapi

fengpan567

2020-08-13 23:26:59 +08:00

yapi

bluehtt

2020-08-14 00:10:48 +08:00 via iPhone

yapi

uxstone

2020-08-14 09:00:10 +08:00

yapi

edk24

2020-08-14 09:10:04 +08:00

我们本地鸡用的 yapi

balabalaguguji

2020-08-14 09:32:33 +08:00

这个很好用，易文档 https://easydoc.top
![preview.png]( https://i.loli.net/2020/08/14/vZacMFjwxSpstyk.png)

monkeyWie

2020-08-14 09:35:15 +08:00

@balabalaguguji 注意是私有部署哦🐶

balabalaguguji

2020-08-14 09:37:50 +08:00

@monkeyWie 支持私有部署，不过没开源，免费的已经很够用

monkeyWie

2020-08-14 09:40:37 +08:00

@balabalaguguji 好吧，还有一个很重要的好像不支持导入 swagger

balabalaguguji

2020-08-14 09:43:36 +08:00

@monkeyWie 支持 swagger，postman 。而且接口测试也是支持，还能一键生成文档、Mock 。

hpu423

2020-08-14 10:14:15 +08:00

apifox

okampfer

2020-08-14 11:33:01 +08:00 via Android

各位同仁，yapi 是不是有一阵子没更新了？

MarioLuo

2021-09-10 11:50:40 +08:00

[烟花][烟花][烟花]
给大家推荐个 API 文档自动生成工具，可抛弃 swagger 了，已支持上传到 YApi, Rap2, Eolinker 平台。

亮点：
- [火] 零入侵、零成本：自动解析 Javadoc 和 spring 等常见注解
- [火] 开箱即用、智能 mock 规则: 默认就能生成很好的 mock 数据
- [火] 多平台支持：目前支持 YApi, Rap2, Eolinker, Copy as cRUL

Github: https://github.com/jetplugins/yapix
IDEA 插件名称: Yapi X
QQ 交流群：860701800

monkeyWie

2021-09-10 12:39:06 +08:00

@MarioLuo 一定要通过 IDEA 插件生成吗，我们现在做的是提交代码的时候文档自动化生成，这个能实现吗

MarioLuo

2021-09-10 13:30:29 +08:00

不支持集成到自动化，不过手动上传也就秒秒钟的事，如果你要自动化可以考虑 smart-doc 这个工具，但是好像不支持 YApi, Rap2 之类