各位公司的 API 接口文档是用的什么方式？

[aschoolboy]

之前公司的 API 接口文档写在 word 里，放在 github 上。
缺点很多，不能同时编辑，一同时编辑就冲突.
我趁一期项目结束，搭了个开源 API 接口网站：eolinker。
给师父看了，说可以，叫我把所有接口都牵进去了。准备让所有同事用了。
结果有的同事一看感觉不方便，说可以用 markdown 来写。
又安排我找个用 markdown 写的 api 文档模板

所以想问问大家的 api 接口文档是采用什么方式的？

[wangcansun]

swagger?=>代码生成文档。
markdown 模式的=>Apiary ？

[cnbattle]

公司用的 apizza

[cnbattle]

可以用 http://www.xiaoyaoji.cn/ 支持 md

[DiverRD]

我推荐 Yapi 楼主可以搜搜看

[billlee]

口述

[aschoolboy]

@billlee #5 哈哈 可以

[mhtt]

我要回农村

[yidinghe]

写了一个框架，要求必须用注解语法来定义接口，然后提供一个 web 页面供查看注解内容。所以文档和代码是同步的。

[PHPJit]

eolinker

[aschoolboy]

@mhtt #7 咋啦兄弟

[RangerWolf]

虽然楼主你搭建的 eolinker 确实强大， 但是我组就用的 markdown

感觉足够了。。。
因为在打开 git 项目的时候， 顺手就能看到 哦， 这个项目的 Readme 有大概介绍。 形成自然反馈了。


可能 API 比较多比较复杂的场景适合 eolinker ？

[dengtongcai]

postman 临时文档……

[oneisall]

graphql = =

[TommyLemon]

自动生成的
apijson.org/

后端接口和文档自动化，前端(客户端) 定制返回 JSON 的数据和结构！
github.com/TommyLemon/APIJSON

[TommyLemon]

@TommyLemon 不需要写任何代码哦

[xiaojie668329]

@billlee 之前我对接的后端真的是过来跟我口述的，或者在微信发条消息……有一次直接把代码截图给我。我搭了个 swagger 又不想学写文件，只好让建个 md 让他更新在上面。🤣

[TommyLemon]

格式是这样的，发不了图片凑活看吧，右侧往下翻，在自动生成的代码下方。

2. User
说明:
用户公开信息表。
对安全要求高，不想泄漏真实名称。对外名称为 User

字段:
名称 | 类型 | 最大长度| 详细说明
id | Long | 15 | 唯一标识
sex | Integer | 2 | 性别：0-男 1-女
name | String | 20 | 名称
tag | String | 45 | 标签
head | String | 300 | 头像 url
contactIdList | List | 不限 | 联系人 id 列表
pictureList | List | 不限 | 照片列表
date | Timestamp | 不限 | 创建日期

[WEAlex]

没有用 rap2 的么，虽然有一些 bug

[TommyLemon]

@TommyLemon
创作不易，GitHub 右上角点 Star 支持下吧，谢谢^_^
github.com/TommyLemon/APIJSON

[TommyLemon]

@TommyLemon APIJSONAuto 在线工具还有很多其它功能：
自动生成文档，清晰可读永远最新
自动生成请求代码，支持 Android 和 iOS
自动生成 JavaBean 文件，一键下载
自动管理与测试接口用例，一键共享
自动校验与格式化 JSON，支持高亮和收展

创作不易，GitHub 右上角点 Star 支持下吧，谢谢^_^
github.com/TommyLemon/APIJSON