什么是接口文档如何写接口有什么规范，get 接口

什么是接口文档，如何写接口，有哪些规范？

第一要有一个文档的标题，XXX接口文档，满足现目前文档的说明，文档的生产日期，还有公司名称等。目前启动写一个dubbo接口文档，定义标题，还有日期，这里公司省略。使用confluence在线编辑，Confluence为团队Team提供一个协作环境。团队Team成员协同地编写文档和管理项目。从此打破不一样团队Team、不一样部门还有个人当中信息孤岛的僵局，Confluence达到了资源的共享。

要有现目前文档的版本修订信息，即为历史修订信息，需要包含基础的信息有：版本号、修订日期、修订人、修订说明等。

启动编写文档的目录结构，注意大标题和小标题的使用，需合理地运用说明。第一当然是文档的说明信息，再来是一部分准备信息和流程信息，然后启动接口说明，后可以有举例、常见问题、须知、响应码的说明信息等等。

下面启动根据文档的目录结构逐步一个个进行具体的讲解说明，例如文档说明的讲解，用高效简洁的语言明确的说明文档信息，注意文档中大标题需要字体大小样式完全一样，小标题也需要字体大小注意保持完全一样。

简单的说明技术资料获取及准备，确认调用系统信息非常重要，需确认编码格式，防止乱码，确认现目前的文档版本是不是是要使用的版本，不然白做无用功，项目标搭建环境简单单就来说一下明就可以。

启动说明接口的调用流程，如何调用接口，需做的一部分准备，说明引入对应的依赖还有配置需配置的文件。

目前可以启动接口的说明，接口的说明信息需要包含接口的名称，接口的地点位置，接口的协议，然后针对现目前接口下的方式说明。

方式的说明需要包含方式的描述，即其作用，方式的请求参数说明，还有响应的参数说明，参数说明需要包含参数的类型，参数名称，参数的含义，还备注参数是不是一定要传递。

9

接口说明完后面，就是文档的末尾，有须知添加一部分须知，或者附录说明，添加标注。

接口文档大多数情况下是提供给商户对接时进行参考及提供帮的一下详细说明文档或API。

里面包含借口说明、接口列表、接口参数列表、签名/验签规则、商户应答规则等说明； 接口大多数情况下要第一考虑安全性，支付类的签名可以参考支付宝和微信支付这种类型的接口文档，业务类的签名可以参考微信公众平台的接口API； 加签是按照商户号、业务参数、随机字符串或时间戳、商户密钥/公钥私钥等根据规则组装参数，然后根据一个签名规则生成签名，以保证接口的安全性；

get接口文档怎么写？

export function obj(params) {

return request({

url: ‘url’,

method: ‘get’,

params,

})

}

export function obj(data) {

return request({

url: ‘url’,

method: ‘post’,

data: data,

})

}

用，传的值对，直接.then.catch就行

let params = ruleForm =这是要发给后端的值

obj(params).then(res = {

}).catch…

软件如何写接口？

推荐使用的是docway 写接口文档，方便保存和共享，支持导出PDF MARKDOWN，支持团队Team项目管理。

一、请求参数

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，它描述的请求体的数据类型。