程序员怎样规范编写接口文档

规范的事情当然要有专业的工具。推荐使用的是docway 写接口文档，方便保存和共享，支持导出PDF MARKDOWN，支持团队项目管理。

一些刚开始写接口文档的服务端同学，很容易按着代码的思路去编写接口文档，这让客户端同学或者是服务对接方技术人员经常吐槽，看不懂接口文档。这篇文章提供一个常规接口文档的编写方法，给大家参考。

一、请求参数

1. 请求方法

GET

用于获取数据

POST

用于更新数据，可与PUT互换，语义上PUT支持幂等

PUT

用于新增数据，可与POST互换，语义上PUT支持幂等

DELETE

用于删除数据

其他

其他的请求方法在一般的接口中很少使用。如：PATCH HEAD OPTIONS

2. URL

url表示了接口的请求路径。路径中可以包含参数，称为地址参数，如**/user/{id}**，其中id作为一个参数。

3. HTTP Header

HTTP Header用于此次请求的基础信息，在接口文档中以K-V方式展示，其中Content-Type则是一个非常必要的header，它描述的请求体的数据类型。

常用的content-type：

application/x-www-form-urlencoded

请求参数使用“&”符号连接。

application/json

内容为json格式

application/xml

内容为xml格式

multipart/form-data

内容为多个数据组成，有分隔符隔开

4. HTTP Body

描述http body，依赖于body中具体的数据类型。如果body中的数据是对象类型。则需要描述对象中字段的名称、类型、长度、不能为空、默认值、说明。以表格的方式来表达最好。

示例：

二、响应参数

1. 响应 HTTP Body

响应body同请求body一样，需要描述请清除数据的类型。

另外，如果服务会根据不同的http status code 返回不同的数据结构， 也需要针对不同的http status code对内容进行描述。

三、接口说明

说明接口的应用场景，特别的注意点，比如，接口是否幂等、处理是同步方式还是异步方式等。

四、示例

上个示例（重点都用红笔圈出来，记牢了）：

五、接口工具

推荐使用的是http://docway.net（以前叫小幺鸡） 写接口文档，方便保存和共享，支持导出PDF MARKDOWN，支持团队项目管理。

1.编程接口就是对于某种逻辑写的一定规范的数据格式，

就是宿主程序跟 Lu通讯用的一组 C 函数。 所有的 API 函数按相关的类型以及常量都声明在头文件 lua.h 中。

2.虽然我们说的是“函数”， 但一部分简单的 API 是以宏的形式提供的。 

除非另有说明， 所有的这些宏都只使用它们的参数一次 （除了第一个参数，那一定是 Lu状态）， 因此你不需担心这些宏的展开会引起一些副作用。

3.C 库中所有的 Lua API 函数都不去检查参数是否相容及有效。

然而，你可以在编译 Lu 时加上打开一个宏开关 LUA_USE_APICHECK 来改变这个行为。

Lu使用一个 虚拟栈 来和 C 互传值。 栈上的的每个元素都是一个 Lu 值 （nil，数字，字符串，等等）。

4.无论何时 Lua 调用 C，被调用的函数都得到一个新的栈， 

这个栈独立于 C 函数本身的栈，也独立于之前的 Lu栈。 它里面包含了 Lu传递给 C 函数的所有参数， 而 C 函数则把要返回的结果放入这个栈以返回给调用者。

5.方便起见， 所有针对栈的 API 查询 *** 作都不严格遵循栈的 *** 作规则。 

而是可以用一个 索引 来指向栈上的任何元素： 正的索引指的是栈上的绝对位置（从1开始）； 负的索引则指从栈顶开始的偏移量。 展开来说，如果堆栈有 n 个元素， 那么索引 1 表示第一个元素 （也就是最先被压栈的元素） 而索引 n 则指最后一个元素； 索引 -1 也是指最后一个元素 （即栈顶的元素）， 索引 -n 是指第一个元素。

4.2 – 栈大小

5.当你使用 Lu API 时， 就有责任保证做恰当的调用。 特别需要注意的是， 你有责任控制不要堆栈溢

---