接口文档编写工具推荐，raml php,比较好的接口文档编写工具

写接口文档的工具，我尝试过很多，我之前用过txt写、用过小幺鸡、用过apizza、用过Showdoc、看云、Gitbook、ReadTheDoc、Yapi、MinDoc、eoLinker、RAR，真的是尝试过很多个，但是他们都有一些不如意的地方。

小幺鸡：样式太丑，直接是十几年前那种table的样式，每添加一行参数都要鼠标点击一下新建，编写体验很差，预览页面真的很丑，接口调试没成功过，也用过它的markdown、富文本，体验都好差

apizza：刚开始我以为终于找到一个靠谱的了，但是！响应参数文档在哪填写！！！？另外没有 markdown，没有不限层级目录结构、子参数，最后只能抛弃。

showdoc：这个是存粹写 markdown 的，虽然可以保存模板，但是用来写 api 文档真的还是太麻烦了，跟写 txt 一样，这种体验，作为懒惰的程序猿是无法忍受的。

易文档：这个是我最喜欢的，有专门的接口编写编辑器，输入很方便快捷，下面给大家介绍下。

易文档 https://easydoc.xyz，专业编写API文档工具，支持HTTP文档，markdown文档，富文本文档

支持在线接口测试，一键生成mock配置，前端不用等服务端开发完接口就能进行测试了。

看下他的预览效果，示例项目

市面很多http接口文档的编写都是直接写 Markdown 文档，这种编写起来特别麻烦。易文档在http文档方面有做专门的处理，做了很多优化体验，比如按tab就可以自动下一个输入框，可以保存一些常用的参数，方便快速引用进来，还有不限层次的子参数，参数行顺序调整。

特别强大的是，他的http文档可以自定义参数块和描述块，比如失败和成功返回的参数不一样，我们可以添加两个参数块，分别对应成功响应参数、失败响应参数

如果你想给每个返回都提供一个示例或者说明，也都没问题，可以自己添加描述块。而且块的顺序是可以调整的，非常方便。

还有更多高级使用技巧：https://easydoc.xyz/#/s/31322154/66267384

这些高级技巧，看完我相信你一定会喜欢上它，大大提升了我们编写接口文档的效率

1、apizza

我现在用的apizza 免费版本的  但是因为要装插件  所以有一些人费点劲   但是还是挺好用的   传送门

2、showdoc

这个也很好用 不用安装   传送门

3、eoLinker

4.RAML

用 YAML 文件格式编写，强大的官方支持，官方提供 atom 插件，支持语法智能提示及校验，编写快速简单。 传送门

另外在介绍几款别的工具

1.Swagger: 据说是当下很流行的

通过固定格式的注释生成文档. 省时省力,不过有点学习成本。

网址：https://swagger.io/

2.apidoc:

可以根据代码注释生成web api文档，web接口的注释维护起来更加方便，不需要额外再维护一份文档。

网址：http://apidocjs.com/

3.RAP：

一个可视化接口管理工具 通过分析接口结构，动态生成模拟数据，校验真实接口正确性， 围绕接口定义，通过一系列自动化工具提升我们的协作效率。

网址：http://rap.taobao.org/org/index.do

4.APIJSON：

客户端可以定义任何JSON结构去向服务端发起请求,服务端就会返回对应结构的JSON字符串,所求即所得。

网址：http://jsonapi.org/

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。