开启掘金成长之旅！这是我参与「掘金日新计划 · 12 月更文挑战」的第5天，点击查看活动详情

在前后端分离的项目中，前后端合作开发共用的一个重要文档就是接口文档——作为接口调用的依据。好的接口文档，可以使开发者明白接口的作用以及如何调用接口，从而提高合作开发的效率。

接口文档会包含哪些内容呢

• 接口名称：用于说明接口的作用，通常言简意赅。
• 接口类型：GET（查询）、POST（创建）、PUT（更新）、DELETE（删除）。
• 接口URL：说明接口地址，由服务url+分组url组成。
• 请求参数：包含参数名称、参数说明、请求类型、是否必须、数据类型。
• 响应状态：选填，包含状态码、说明，用于对响应的状态码进行说明。
• 响应参数：包含参数名称、参数说明、类型。
• 响应示例：选填，列举返回数据的结构。
• 接口描述：选填，描述注意事项。

GET、POST与PUT

GET&POST

• get请求放在请求头中，通过？与地址分割，通过&连接不同的get请求；而post请求放在请求体中
• get请求有大小限制，这个相纸不是http协议对它的限制，而是不同服务器和浏览器对它的限制，以防止请求头过大导致数据传输速度慢；而post请求没有大小限制
• get请求不安全，因为get请求参数会被完整保留在浏览器历史记录，重要数据不能用get传输；而post请求相对安全，post中的参数不会被保留
• get请求会被浏览器主动缓存，post不会，除非主动设置
• 一般在浏览器中输入网址访问网站是get请求

POST&PUT

• 当两个请求相同时，put请求的后一个请求会把前一个覆盖，所以用来修改资源
• post请求的后一个请求不会把前一个覆盖掉，所以用来新增资源。

注意数组

• 因为get请求是在url中传参的，所以array类型需要转换为json格式后传参；
• 而post、put是在body中传参的，array类型不需转换。