设计接口时，要考虑的因素很多，比如接口的业务定位、接口的安全性、接口的可扩展性、稳定性、跨域性、接口的协议规则、接口的路径规则、单接口原则、接口过滤和接口组合等。本文将简要分析这些因素。

一 规范性建议 1.职责原则设计接口时，接口的职责，即接口类型，接口应该解决哪些业务问题等。必须明确定义。

00-1010在接口职责明确的情况下，尽量单一接口，即一个接口只能做一件事，不能超过两件。很多非资深的界面设计师总是认为设计界面的时候，做的越多越好。这是一个非常严重的误解。

2.单一性原则设计接口时，要明确接口协议是HTTP、HTTPS还是FTP，具体要看具体情况。

FTP(简称文件传输协议)是一组标准的文件传输协议，用于传输文件，如。txt，csv等。对于一般的文件传输，采用FTP协议HTTP协议，适用于安全性要求低或者没有安全性要求的业务场景，HTTPS=HTTP SSL，适用于安全性要求高的业务场景3.协议规范。因为api获得了一个资源，所以尽量在网址中使用名词。

/API/v 1.0/pr upduct/2019/API/v 1.0/users/2019

00-1010接口基本访问协议：获取、发布、放置和删除。

Get /users:列出所有用户get /users/id:根据id获取用户帖子/用户：添加用户投放/用户/id:根据用户id更新用户删除/用户/id:根据用户id删除用户4.路径规则。域名一般分为主域名和专有域名。主域名适用于api长期不变或变化不大的服务，专有域名用于解决特定的专有服务。

00-1010 (1)主域名：www.baidu.com

(2)产品服务类别

百度文库：https://wenku.baidu.com/百度知道：https://zhidao.baidu.com/百度信息：https://zhidao.baidu.com/(3)营销活动

百度公益：http://gongyi.baidu.com百度LOGO:http://logo.baidu.com/百度世界：https://baiduworld.baidu.com 5.http请求方式在域名明确的情况下，一定要考虑界面是否跨域，跨域应该采用的技术手段。

6.域名对于接口的url，应该添加版本号http://api.demo.com/v{d}/，例如，其中d代表版本号，如v1.0和v2.0

示例：获取产品编号为2019、版本号为v1.0的版本号的产品信息

/API/v 1.0/Pruports/2019

00-1010当记录数量较大时(如SELECT * FROM TBName)，会通过增加一些条件对数据进行过滤，如TOP、分页、分组、排序、WHERE条件。

以百度举例： ?限制=100:返回100条数据？Offset=101:从第101个数据返回？Page=10:指page 10 per_page=100:每页100条数据？Sortby=name:排序字段？顺序=desc:降序？Group=groupname:Grouping？product _ type=1:Filter 7.跨域考虑返回数据格式，一般包括三个字段：

(1)故障情况(状态码、错误码和错误描述)

(2)成功(标识、数据对象、状态码)

8.api版本

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

12.可扩展性原则

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

13.定义api界限

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

14.定义api返回码

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

1 --授权过期404--未找到资源500--内部服务器错误600--账号被锁

二 反规范性建议

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

1.Request

2.Responce

三 实例

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

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

（一）定义统一参数

1.定义统一输入参数

2.定义统一输出参数

3.定义统一错误码

（二）定义接口授权类别

如下为定义接口授权类别

（三）用户接口

1.用户注册

2.Request

3.Responce

4.code示例

（四）用户登录

1.登录接口概述

2.Request

3.Responce

4.Code