接口规范

一、Web API接口

1.1 什么是接口

同通过网络，规定前后台信息交互规则的url连接，是前后台信息交互的媒介。

1.2 接口的组成

1、url;

2、请求方式：get、post、put、patch、delete;

3、请求参数：json或xml格式的key-value类型数据；

4、响应结果：json或者xml格式的数据

1.3 编写接口文档

编写接口文档可以使用去哪网技术中心的一个开源可视化接口管理平台YApi。

http://yapi.demo.qunar.com/

二、Restful接口规范

REST全称是Representational State Transfer，中文意思是表述性状态转移,首次出现是在2000年Roy Fielding的博士论文中。

2.1 URL设计

1、数据安全的保障

url连接一般采用https协议进行数据传输，可以提高数据交互过程中的安全性。

2、接口特征的表现

使用api关键字标识接口：https://api.lalala.com。

注意：出现api，就代表该请求的url连接是为了完成前后台数据交互的。

3、多版本数据共存

https://api.lalala.com/v1与https://api.lalala.com/v2，就是不同版本数据的体现。

4、数据即资源

接口即前后端交互的媒介，交互的数据即为资源。

https://api.lalala.com/users、https://api.lalala.com/data。

推荐资源写复数形式，便于理解。

连接中不要出现操作资源的动词，例如https://api.lalala.com/delete-user。

没有明确资源的接口可以使用动词，或者东西就是接口的核心含义可以使用动词。

例：https://api.lalala.com/login或https://api.lalala.com/content/search

2.2 响应状态码

1、正常响应

响应状态码2xx
- 200：常规请求
- 201：创建成功
2、重定向响应
响应状态码3xx
- 301：永久重定向
- 302：暂时重定向
3、客户端异常
响应状态码4xx
- 403：请求无权限
- 404：请求路径不存在
- 405：请求方法不存在
4、服务器异常
响应状态码5xx
- 500：服务器异常

接口规范-API接口相关推荐

Spring Boot API 接口文档 Swagger 入门
转载自芋道 Spring Boot API 接口文档 Swagger 入门摘要: 原创出处 http://www.iocoder.cn/Spring-Boot/Swagger/ 「芋道源码」欢迎转 ...
数据接口请求异常:error_springboot2.2.X手册：构建多元化的API接口，我们这样子设计
无规矩不成方圆,任何一个软件,如果刚开始没有定义好规范,任由各个开发进行按照自己的喜好进行开发,后面运维的兄弟,估计整天就要骂娘了. 开发一时爽,运维火葬场,运维一个软件,往往比开发一个软件要辛苦好多 ...
【编程规范】后端API接口设计编写与文档编写参考
文章目录 0 统一规范 0.1 理清业务流程 0.2 定义前后端开发的接口规范 0.3 定义接口文档 1 后端接口编写 1.0 后端接口介绍 1.0.1 接口交互 1.0.2 返回格式 1.0.3 C ...
【Web接口测试_基础概念】接口概念、接口分类、接口定义、接口规范、接口方法、接口用例设计整理
[接口基础] 1.接口测试概念 1.1 基础概念接口的定义:接口英文"interface",表示某个对象和外界交互的部分. 1.2接口的分类: ①用户UI接口,表示提供给用户操作 ...
16. 设计模式之契约原则：如何做好 API 接口设计？
一.契约式设计原则:API 设计的指导书无论是架构设计还是编码实现,现在都越来越离不开接口设计,接口可以说是新时代的"集装箱",是得到了几乎所有人一致共识的通用标准. GoF 在 ...
芋道 Spring Boot API 接口文档 Swagger 入门
点击上方"芋道源码",选择"设为星标" 做积极的人,而不是积极废人! 源码精品专栏原创 | Java 2020 超神之路,很肝~ 中文详细注释的开源项目 RP ...
拼多多商品数据如何通过api接口获取
要从拼多多获取商品数据,可以使用拼多多提供的API接口.首先需要注册一个拼多多开放平台的开发者账号,然后创建一个应用程序,获取应用程序的app_id和app_secret,以在API请求中进行身份验证 ...
快递鸟全球物流单号查询api接口
快递鸟全球物流单号查询API接口旨在为电商.电商平台.物流工具.打单工具.仓储系统.移动APP等系统提供专业.稳定.优质的API 接口服务,满足不同用户的物流管理需求.本文档就各个API接口进行详细说 ...
银行卡信息验证API接口调用接入流程
银行卡信息验证接口广泛的用于担保.法律.航空.物流.婚恋.旅游.租赁等行业,通过接口能够快速的对个人银行卡相关信息的真伪进行核验,推进完善可靠的互联网信用基础的建立.下面,来具体的了解下银行卡信息验证 ...

接口规范-API接口