springboot中接口实例化_无规矩不成方圆

接口基本访问协议：get(获取)，post(新增)，put(修改)和(删除)

6.域名

一般地，域名分为主域名和专有域名，主域名适合api长期不变或变化较少的业务，专有域名是解决具体的专有业务的

以百度举例：

(1)主域名:

(2)产品服务类

(3)市场活动类

7.跨域考虑

在明确域名的情况下，一定要考虑接口是否跨域，以及跨域应采用的技术手段等。

8.api版本

对于接口的url，应加版本号{d}/，如 ，其中d表示版本号,如v1.0,v2.0

例子：获取产品号为2019,版本号为v1.0的版本号的产品信息

/api/v1.0//2019

9.适度过滤信息

当记录数比较多时(如 * FROM )，因适当添加一些条件对数据进行过滤，如TOP,分页,分组，排序和WHERE条件等

下面是一些常见的参数。 10.返回数据格式

返回数据格式，一般包括三个字段：

(1)失败情况(状态码、错误码和错误描述)

(2)成功情况(标识id,数据对象,状态码)

11.安全性原则

接口暴露的考虑，接口并发量的考虑，接口防攻击的考虑，接口跨域的考虑等

12.可扩展性原则

在设计接口时，充分考虑接口的可扩展性。

13.定义api界限

任何api，从权限上，可归结为匿名api和非匿名api，前者不需要验证，后者需要验证

14.定义api返回码

在api设计时，要定好api返回码，如

二 反规范性建议

存在这样一种业务场景：某个接口需要返回多个api接口组合的结果 ，在类似的业务场景下，所设计的接口，具有一定的反规范性。

1.

2.

三 实例

假设存在这样一个一个业务：一个ERP系统，需要提供两个接口，一个是用户访问接口(需要验证)，另一个是用户注册接口(不需要验证)。

根据本篇文章一，二部分的建议，我们来设计满足该业务需求的接口

(一)定义统一参数

1.定义统一输入参数

2.定义统一输出参数

3.定义统一错误码

(二)定义接口授权类别

如下为定义接口授权类别

(三)用户接口

1.用户注册

2.

3.

4.code示例

(四)用户登录 1.登录接口概述

2.

3.

4.Code