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

[anankun]

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

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

[anankun]

@xuanbg 目录能固定在页面上就好了

[Takamine]

conference。

[Takamine]

@Takamine 呸，Confluence 和 Jira。

[hnbcinfo]

项目开发中，做好接口规范，接口名称和请求响应参数描述，利用 Attribute 及注释标注。每次项目编译，利用 Yapi 的开放接口，自动同步已经开发好的接口，包含接口分组、字段注释，接口描述等完整信息。

[ggicci]

我喜欢用 apiary。

1. 我把接口文档和源码一起维护；
2. 每次更新文档都提交到 apiary 服务（支持自建，docker 拉一个就好），它会帮你渲染，方便浏览和调试，这个就有点类似 postman 了。

[ggicci]

加一句，apiary 是 api-blueprint 的 api 文档编写规范，学习曲线稍会偏高。所以用的人可能不是很多。

[xuanbg]

@anankun Pytora 有导航的

[axbx]

一个 excel,上传到项目的 SVN。

[TommyLemon]

@Macolor21
@liuxey
@via
看清楚 APIJSONAuto 和 APIJSON 是两个项目

自动化接口管理工具 （ 300 + Star ）
github.com/TommyLemon/APIJSONAuto/

自动化接口与文档 ORM 库（ 6100 + Star ）
github.com/APIJSON/APIJSON/

再说人家提问，回答问题有啥不对？对某些需要的人也是有帮助的。
你们这种宣泄情绪的评论才是违反 V2EX 规则的。
“请尽量让自己的回复能够对别人有帮助”

[zaul]

小幺鸡

[TommyLemon]

@TommyLemon APIJSONAuto-自动化接口管理工具 类似 postman，对代码无任何入侵，也不需要写任何代码哦

[Kenyore]

swagger 大法好

[Edsie]

能把他屏蔽了吗？

[zgcwkj]

口口相传（就是嘴对嘴，一张对一张，传递下去）

[oliver34]

@acumen 优秀

[robinlovemaggie]

离线版的我觉得不如搞个小本本记下了得了

[ibugeek]

现在用 eolinker，感觉比 yapi 好一些

[ifane]

apidoc 的没有么

[cctv1005s927]

看到 apijson 就烦..

[leafre]

swagger