素材牛VIP会员
适合写接口文档的工具,或者文本语法
 风***扬  分类:PHP代码  人气:2193  回帖:14  发布于6年前 收藏

由于后端与前端使用ajax交互,后端写接口文档变得非常有必要。以前我习惯用word写接口文档,但是最近与同事合作编写后端,word并不适合使用svn工具做同步,因为svn、git等无法自动合并word。所以打算把文档写成文本的格式。

一开始想到的是用markdown语法来写。markdown语法大全

但是接口文档最重要的一个特性是,接口多,需要给每个接口标序号(如下图)。
当然markdown支持序号,但是支持得并不完美,比如上下两个序号之间最多只能有一个空行,并且空行不能写文字,这样就只能光写接口标题了,没有空间写接口内容了。

请问适合写接口文档的方法是什么?最好就是一种语法,而不是一个软件


感谢大家的回答,考虑到markdown目前的趋势,还是决定继续使用markdown,现在已经想到解决办法,markdown只是一种语法,到底怎么显示,还是由软件或者浏览器插件来决定的,我找到两款chrome插件

Markdown Preview Plus

能自动把原文中的标题提取出来生成目录,并且能给目录自动加序号(如果原文标题本身就有序号,它也会加自己的序号,所以原文标题不能有序号)

Markdown Viewer

同样能把原文中的标题提取出来生成目录,但是不会加序号,对于不需要序号,或者接口较少的,可以用这个,我更喜欢这个插件的目录样式,可惜功能缺了一点。


这两款插件其实是提供给文档阅读者的,文档编辑者倒是可以不需要,全看个人喜好了,chrome官方市场里就找到这两款了,不知道国内有没有人开发了插件没传到chrome市场

讨论这个帖子(14)垃圾回帖将一律封号处理……

Lv5 码农
夏***t 移动开发工程师 6年前#1

我推荐 RAML
目前一直在使用,采用 YAML 文件格式编写,强大的官方支持,官方提供 atom 插件,支持语法智能提示及校验,编写快速简单。

  1. 支持 examples
  2. 支持 schema 校验
  3. 支持工具测试

官方提供 API CONSOLE,支持渲染
DEMO APPLICATION

这一切都是免费开源的。

Lv6 码匠
你***饭 学生 6年前#2

GitBook或者Swagger-UI都可以。比较推荐Swagger-UI,在写代码的时候添加注释即可生成文档。

Lv6 码匠
飞***猪 交互设计师 6年前#3

postman

Lv4 码徒
大***咒 JAVA开发工程师 6年前#4
上一页12下一页
 文明上网,理性发言!   😉 阿里云幸运券,戳我领取