什么叫接口文件

接口文件简单理解就是类似于头文件里面定义类的各种接口和函数以供用户使用。

发布接口就是一个小的页面颤搜手程序通常和WEB在线发布模块配合使用。来满足用户的特定需求。简单的说就是采集器将采集的数据发送到发布接口文件中，接口文件得到数据，并按照用户特定需求处理数据，用户可以更加灵活自由茄嫌的处漏好理采集器采发送的数据。

规范的事情当然要有专业的工具。推荐使用的是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，支持团队项目管理。

keyshot接口余盯程序安装在solidworks插件目录中。根据查询相关公开信息显示，安装接口文件，keyshot就会出现在solidworks的插件目录中，可以通过solidworks软件界面直接打郑滑开进入keyshot界竖丛和面，而不需事先启动keyshot。

---