如何设计接口

1、单一职责原则

每个接口只负责一件事

2、定义协议规范

在设计接口时应明确接口协议，通常有一下几种：

• HTTP协议：适用于对安全性要求比较低的场景
• HTTPS：HTTP+SSL，适用于对安全性要求较高的场景

3、命名规则

由于API获取的是一种资源，所以网址中尽量为名词

4、HTTP请求方式

符合RESTful风格

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

get     /users：列出所有用户

get    /users/id：根据id获取用户

post   /user：新增用户

put      /user/id：根据用户id更新用户

delete   /user/id：根据用户id删除用户

5、适度过滤敏感信息

对链接地址进行过滤，防止SQL注入

6、固定好返回数据格式

{

“status”:0,//状态码 0-表示失败，1-表示成功

“error_code”:”2003”,//错误码，一般在设计时定义

“error_des”:”身份验证失败”//错误描述，一般在设计时定义

}

7、可扩展性

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