大家前后端的接口文档一般用什么写？

[yellowV2ex]

我是前台(Flash,iOS)目前是用markdown写导出html给PHP们看，列明每条接口的PHP名字，传入什么参数，返回什么内容之类。
大概是这样子的一个东西，http://coonlab.com/ahhapuzzle_api.html

虽说用起来不错，但觉得是不是有专门的工具去干这个事情的，你们跟后台定义接口的时候的文档是用什么工具写的？
（因为前台需求是主导，所以不可以用后台直接生成的那种接口文档，因为首先要告诉他们我需要返回什么样的数据，而不是他们自己去定返回什么给我）

[churchmice]

有敏感词唉

[yellowV2ex]

@churchmice 哪里哪里

[jsq2627]

@yellowV2ex /t/123763

[TangMonk]

http://apiblueprint.org/

楼主不如看下这个，

[zhouzm]

写文档推荐 sphinx(sphinx-doc.org),开源项目可以用 readthedocs.org 托管文档。

如果是内部开发，也可以自建 readthedocs 服务器 + git/svn

[sxd]

为什么是前台写文档给后台 接口不是后台定么?

[ijse]

http://apiary.io/ 这个挺不错的，用的也是api blue print

[yellowV2ex]

@sxd 先出的设计，然后前台就按照设计做，根据设计的字段定义需要的接口内容，所以前台是主导，要是后台去写的话，后台还要去研究设计和页面跳转什么的，比较麻烦。

@TangMonk @zhouzm @ijse 谢谢推荐，我去试试看
@jsq2627 噗

[Mutoo]

vimeo已经被认证好多年了，真理部不喜欢这群搞艺术的，特别是有想法的搞艺术的。

[Mutoo]

@Mutoo 不好意思，穿越帖子了

[oa414]

LZ试试这个东西， https://helloreverb.com/developers/swagger

根据代码和注释自动生成文档，还可以在线调试。。

[lynnlee]

我以为都用word呢

[erse]

dokuwiki

[zouxcs]

现在文档都走高端路线了，想当年写word文档到吐啊

[lidl]

我需要本地编写api文档　，并导出pdf或html
用什么　工具　，求教。

[yellowV2ex]

@lidl Markdown，写好了找个工具导出PDF或html，我现在就是

[errun]

@yellowV2ex 我也是用markdown，但是现在感觉markdown还是比较适合用来写文章，用来写接口文档太累了，毕竟接口文档实际上有个基本的格式的，写接口文档的工具应该只用关心填写内容就好了，不必去关心格式。。

[pheyer]

发现了一个好工具RAP，阿里内部使用的，也许对大家有用，介绍可以参考http://div.io/topic/642，接口自动化工具RAP的设计思路
宣传片：v.youku.com/v_show/id_XNjk5NjMxODA4.html
官网： http://thx.github.io/RAP/index_zh.html
源码： https://github.com/thx/RAP
入门视频：thx.github.io/RAP/study.html
部署RAP服务的文档： https://github.com/thx/RAP/wiki/deploy_manual_cn

[zhishizhanghao21]

小幺鸡，简单好用的在线接口文档管理系统
支持在线测试，经测试（可降低接口错误率）。
支持 json ， js ， websocket ，二进制测试。
支持 restful 接口。

[zhishizhanghao21]

@zhishizhanghao21 www.xiaoyaoji.com.cn