大家分享一下 API 文档管理工具？

V2EX = way to explore

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

现在注册

已注册用户请登录

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

大家一般都用什么 API 文档管理工具？
分享一下。

我一般主要使用 mac 上的 Dash，不过还有两个缺点：

不好直接修改文档
图片不好存储。有类似的问题吗，怎么解决呢？

API

文档

dash

工具

23 条回复 • 2021-07-10 00:29:32 +08:00

TommyLemon

2019-04-29 17:47:01 +08:00

自动查数据库表和字段属性，生成数据字典文档。
自动给请求 JSON 加注释，自动给返回结果 JSON 光标悬停显示注释。

一键全自动化接口回归测试，不用写任何代码，不用做任何配置。

APIJSONAuto-自动化接口管理工具，自动生成代码、自动静态检查、自动化回归测试、自动生成文档与注释等。
GitHub 右上角点 Star 支持下吧 ^_^
https://github.com/TommyLemon/APIJSONAuto/

TommyLemon

2019-04-29 17:47:46 +08:00

@TommyLemon 还支持多账户，自由添加和切换使用

kkjinping

2019-04-29 17:51:36 +08:00

swagger

ooee2016

2019-04-29 17:53:29 +08:00

eolinker

luosuosile

2019-04-29 17:56:13 +08:00

swagger +1

jeremysss

2019-04-29 18:04:01 +08:00

去哪儿的 YAPI，Node + React 写的，有源码可以拉下来自己改，支持本地部署，8000+ star https://github.com/YMFE/yapi

TommyLemon

2019-04-29 18:08:05 +08:00

@kkjinping @ooee2016 @luosuosile
APIJSONAuto 比 Swagger 强大易用很多哦
https://github.com/TommyLemon/APIJSON/issues/27

sunjourney

2019-04-29 18:08:43 +08:00

swagger

my101du

2019-04-29 18:44:53 +08:00 via Android

提问者多写了个 API, 回答者只看了个 API...

dfjslkjdf

2019-04-29 18:47:22 +08:00

@my101du
没事，有内容的回答都欢迎。

ifwangs

2019-04-29 19:51:04 +08:00 via Android

可以试试 showdoc

AngryPanda

2019-04-29 19:53:02 +08:00 via Android

yapi 的确不错

daodao116

2019-04-30 09:11:44 +08:00

swagger

TommyLemon

2019-04-30 10:20:01 +08:00

@dfjslkjdf 赞

skiy

2019-04-30 10:56:52 +08:00

https://github.com/lifei6671/mindoc

https://www.iminho.me/

MinDoc 是一款针对 IT 团队开发的简单好用的文档管理系统。

MinDoc 的前身是 SmartWiki 文档系统。SmartWiki 是基于 PHP 框架 laravel 开发的一款文档管理系统。因 PHP 的部署对普通用户来说太复杂，所以改用 Golang 开发。可以方便用户部署和实用，同时增加 Markdown 和 HTML 两种编辑器。

Go 项目

---------------------------------------------------------------------------------------------
https://github.com/EhsanTang/ApiManager

http://api.crap.cn

一个由免费开源的 API 接口、文档管理系统（应用接口管理系统）

Java 项目

---------------------------------------------------------------------------------------------
......等等

skiy

2019-04-30 11:00:22 +08:00

不过楼主的可能搞糊涂了。
Dash 不算是 API 文档管理工具吧？
应该是文档管理工具。

skiy

2019-04-30 11:02:41 +08:00

Zeal 这款用过，虽然跟 Dash 有点差距，但类似。跨平台的，挺好用。

dfjslkjdf

2019-04-30 11:06:53 +08:00

@skiy
Dash is an API Documentation Browser and Code Snippet Manager.
主要就是管理 api 和代码片段。