大家接口文档都是怎么管理的。

[anankun]

我是公司后端开发，目前公司接口使用的是 word 记录，在 svn 上 管理的。 现在一个工程的接口文档到了快 200 页，电脑编辑保存下文档真是卡的不行。

想问下大家都是管理接口文档的，最好是离线的，公司不允许接口文档上外网。

[mylxsw]

推荐用 wizard，内网部署 https://github.com/mylxsw/wizard

[anankun]

用 swagger 写，代码侵入感觉太多了。单后端看还行，前端看有些实体的参数确定不了

[brust]

swagger
jsonapi

[TommyLemon]

比 Postman，Swagger，EOLinker，Rap，apidoc 等一堆工具在基础的文档、测试方面要强大易用很多。

自动化接口管理工具，自动生成代码、自动静态检查、自动化回归测试、自动生成文档与注释等。
* 自动生成接口文档，清晰可读永远最新
* 自动校验与格式化，支持高亮和收展
* 自动生成各种语言代码，一键下载
* 自动管理与测试接口用例，一键共享
* 自动给请求 JSON 加注释，一键切换
* 自动保存历史请求记录，一键恢复

代码已开源，可以点 Star 支持下哦 ^_^
github.com/TommyLemon/APIJSONAuto

[TommyLemon]

@TommyLemon 可以拿源码部署到公司内部，自带测试用例 Demo，有部署文档教程、使用视频教程 等

[TommyLemon]

[Macolor21]

....*** 楼上这个又来了。。真的是

[chendy]

我猜会有人来推他的 apijson （虽然 block 了…

[liuxey]

现在看到 APIJSON 就烦，不管是作品还是作者！

[salamanderMH]

yapi

[rbuli]

@acumen 哈哈哈哈，秀儿是你吗

[coosir]

eolinker

[jorneyr]

我们使用 yApi

[littlewing]

不让上外网为什么就得是离线的？难道你们公司没内网吗

[via]

哈哈哈哈，我也觉得那个人会来。

----

我目前用的是 gitbook cli，但是当 md 文件数量上到 100 多以后，build 一次很慢，大概需要 20 秒。gitbook 还有个好处是可以生成一本 PDF，带封面和目录，可以说很好看了。但是 gitbook cli 目前似乎不维护了，他们家现在主推他们的在线托管服务。

然后用 vscode 来编辑。

[anankun]

@littlewing 有道理，看了回复发现部署个内网 yapi 也是很好。

[xuanbg]

直接写 readme.md 里面，gitlab 里面和后端项目在一起。格式是有模板的，http://api.yitu8.cn 可以参考下，顺便提点意见。

[anankun]

@via VS code 确实可以，几万个字符也不带卡顿的，typora 下拉都是一顿一顿的

[ooee2016]

eolinker

[ooee2016]

@SirLostWhite 一样