你们团队都是怎么管理 API 文档的

2017-02-16 08:34:41 +08:00
 jimyan

api   文档是用 wiki 还是 doc

17625 次点击
所在节点    程序员
102 条回复
zhangliang605
2017-02-17 09:54:55 +08:00
Confluence 。
是我们是一个 1200+人的团队,面临开发,测试,产品经理,项目经理,运营,商务等等各个部门的协作。 Confluence 能跟公司的通信录系统,邮箱系统对接。当关注的文档发生变化时,立即发送邮件给相关同事。同时, Confluence 支持各种插件,富文本编辑,代码高亮,评论,备注等等功能一应俱全。
antowa
2017-02-17 10:20:02 +08:00
我司使用意念传输。精神授权。
settings
2017-02-17 11:42:09 +08:00
@klgd 默认不支持,可以反射 markdown ,我们是用 swagger api 反射 markdown ,再把 markdown 提交 git ,通过 gollum 展示 wiki 。

生成 markdown 的脚本: https://github.com/ZhangBohan/swagger_to_markdown
keepcleargas
2017-02-17 11:45:38 +08:00
slate + git
wjh3936
2017-02-17 12:31:09 +08:00
文档?看代码 [冷漠脸]
sumuu
2017-02-17 12:59:47 +08:00
Swagger + Google Drive
klgd
2017-02-17 13:34:23 +08:00
@settings 呃~
要这么麻烦哦
billyu
2017-02-17 13:35:58 +08:00
我用的 EasyAPI
caotian
2017-02-17 15:36:32 +08:00
settings
2017-02-17 16:35:52 +08:00
@klgd 恩,是的 :D
Hypn0s
2017-02-17 17:14:04 +08:00
Confluence+1
flowerwrong
2017-02-17 17:15:10 +08:00
口口想传
sampeng
2017-02-17 19:48:17 +08:00
api 是什么东西?可以吃吗?
airingursb
2017-02-19 14:01:53 +08:00
rap
962680038
2017-02-20 10:00:42 +08:00
SBDoc 不错啊,楼主可以去了解下,操作很简洁,效果很好,链接: http://123.57.77.6/
dozer47528
2017-02-20 10:48:44 +08:00
想不收费自己搭建的话,可以使用 https://apiblueprint.org/
它本身提供云服务,但也可以自己搭建。写文档就是写 markdown , github 也认这种格式。





然后开源社区已经做好了各种工具,包括把 apiblueprint 格式生成 html , apiblueprint 生成 mock server 等等,非常方便。
我做了个 docker 镜像,只要提供你们写文档的 git 仓库,就可以一键搭建。包含文档服务器, mock server 和 hook api (文档更新的时候自动更新相关内容)
https://github.com/dozer47528/api-blueprint-docker

另外,你可能会需要对静态网站做 oauth2 认证功能,可以利用这个东西: https://github.com/bitly/oauth2_proxy

可以配置邮箱白名单,这样只有你们公司的人能访问了。
HowToMakeLove
2017-02-20 21:43:04 +08:00
apidoc
jsq2627
2017-03-09 13:04:34 +08:00
个人觉得从测试用例生成文档是体验最棒的文档开发方式。

最近给 node.js 做的轮子,强力推荐一下
https://github.com/stackia/test2doc.js
yuhanle
2017-03-21 14:11:19 +08:00
先开大会,再开小会,最后一对一,手把手同步需求
HuntBao
2017-09-28 11:48:20 +08:00
可以试试 NEI 接口管理平台: https://nei.netease.com

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/340795

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX