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

freestyle

2017-02-16 19:50:09 +08:00

API 的话 Swagger 搭一个本地服务器然后用 yaml 写文档就行了，自动渲染高亮

jimyan

2017-02-16 20:28:01 +08:00

@freestyle 这个只能是 java 吗

lgn21st

2017-02-16 20:40:46 +08:00

居然没有 https://github.com/lord/slate

freestyle

2017-02-16 20:52:58 +08:00

@jimyan 任何语言 API 是 json 构建的就行官网:http://swagger.io/swagger-ui/ github:https://github.com/swagger-api/swagger-ui clone 下来, 随便搞个简单 http 服务器, dist 目录作为作为 root 目录就可以跑起来也可以后面小修改下加登录才能查看语法规范在这里 https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md

klgd

2017-02-16 21:16:20 +08:00

@settings 嗯是的可以对比吗？

Monstercat

2017-02-16 21:18:43 +08:00

Github Private Repo 放 MD...

lzjamao

2017-02-16 21:23:23 +08:00

无

abirdcanfly

2017-02-16 22:42:01 +08:00

我是业务部门的, 对接的 IT 部门每用一次 API 让我们在对接门户导一次 <<<吐槽

langjiyuan

2017-02-16 22:55:42 +08:00

意念传输 2333

IgniteWhite

2017-02-16 23:14:18 +08:00

楼主附言的背后应该是一张面无表情的脸

romennts

2017-02-17 00:32:35 +08:00

@kancloud 我在用看云 Hhhh

cxbig

2017-02-17 02:00:55 +08:00

公司用 Atlassian 的产品
所以需求和设计文档一般都是 Confluence 做描述， PSD 类设计文件用 Google Drive 共享。
关于 API 文档，如 PHP 项目：公司要求每个 attribute 和 method 必须写清楚 PHP Doc ，大家都用 PhpStorm ，一个类有什么东西、怎么用一目了然。

msg7086

2017-02-17 03:34:55 +08:00

意念传输，这个总结得很好……

whalegia

2017-02-17 05:25:27 +08:00

OneNote + Swagger

rashawn

2017-02-17 06:43:37 +08:00

通过代码生成缺点是代码里注释有点多…

Cbdy

2017-02-17 07:43:51 +08:00

根据代码注释生成文档（ javadoc ）+ 根据 api 接口使用 springfox 的工具生成 adoc

只要写好代码，文档都是自动生成的

winglight2016

2017-02-17 09:25:52 +08:00

意念传输——就服这个，能传授吗？

juice

2017-02-17 09:29:46 +08:00

postman ， swagger

Yuansir

2017-02-17 09:30:06 +08:00

居然没有 gitbook

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

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

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

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