ToB企服应用市场:ToB评测及商务社交产业平台

标题: 怎样设计一个安全的API接口详解 [打印本页]
作者: 勿忘初心做自己    时间: 2024-6-15 00:40
标题: 怎样设计一个安全的API接口详解
前言

在一样平常开辟中，总会接触到各种接口。前后端数据传输接口，第三方业务平台接口。一个平台的前后端数据传输接口一般都会在内网情况下通讯，而且会使用安全框架，所以安全性可以得到很好的掩护。这篇文章重点讨论一下提供给第三方平台的业务接口应当怎样设计？我们应该思量哪些题目？


重要从以上三个方面来设计一个安全的API接口。

一 安全性题目

安全性题目是一个接口必须要保证的规范。如果接口保证不了安全性，那么你的接口相当于直接袒露在公网情况中任人蹂躏。

1.1 调用接口的先决条件-token

获取token一般会涉及到几个参数appid，appkey，timestamp，nonce，sign。我们通过以上几个参数来获取调用系统的凭证。
appid和appkey可以直接通过平台线上申请，也可以线下直接颁发。appid是全局唯一的，每个appid将对应一个客户，appkey需要高度保密。
timestamp是时间戳，使用系统当前的unix时间戳。时间戳的目的就是为了减轻DOS攻击。防止请求被拦截后一直实验请求接口。服务器端设置时间戳阀值，如果请求时间戳和服务器时间超过阀值，则相应失败。
nonce是随机值。随机值重要是为了增加sign的多变性，也可以掩护接口的幂等性，相邻的两次请求nonce不允许重复，如果重复则以为是重复提交，相应失败。
sign是参数签名，将appkey，timestamp，nonce拼接起来进行md5加密（当然使用其他方式进行不可逆加密也没题目）。
token，使用参数appid，timestamp，nonce，sign来获取token，作为系统调用的唯一凭证。token可以设置一次有用（如许安全性更高），也可以设置时效性，这里推荐设置时效性。如果一次有用的话这个接口的请求频率大概会很高。token推荐加到请求头上，如许可以跟业务参数完全区分开来。

1.2 使用POST作为接口请求方式

一般调用接口最常用的两种方式就是GET和POST。两者的区别也很显着，GET请求会将参数袒露在浏览器URL中，而且对长度也有限制。为了更高的安全性，所有接口都接纳POST方式请求。

1.3 客户端IP白名单

ip白名单是指将接口的访问权限对部分ip进行开放。如许就能避免其他ip进行访问攻击，设置ip白名单比较贫苦的一点就是当你的客户端进行迁移后，就需要重新联系服务提供者添加新的ip白名单。设置ip白名单的方式很多，除了传统的防火墙之外，spring cloud alibaba提供的组件sentinel也支持白名单设置。为了低落api的复杂度，推荐使用防火墙规则进行白名单设置。

1.4 单个接口针对ip限流

限流是为了更好的维护系统稳定性。使用redis进行接口调用次数统计，ip+接口所在作为key，访问次数作为value，每次请求value+1，设置逾期时长来限制接口的调用频率。

1.5 记录接口请求日志

使用aop全局记录请求日志，快速定位异常请求位置，排盘题目缘故原由。

1.6 敏感数据脱敏

在接口调用过程中，大概会涉及到订单号等敏感数据，这类数据通常需要脱敏处理，最常用的方式就是加密。加密方式使用安全性比较高的RSA非对称加密。非对称加密算法有两个密钥，这两个密钥完全差别但又完全匹配。只有使用匹配的一对公钥和私钥，才能完成对明文的加密息争密过程。

二 幂等性题目

幂等性是指任意多次请求的执行结果和一次请求的执行结果所产生的影响类似。说的直白一点就是查询操纵无论查询多少次都不会影响数据自己，因此查询操纵自己就是幂等的。但是新增操纵，每执行一次数据库就会发生变化，所以它黑白幂等的。
幂等题目的解决有很多思路，这里讲一种比较严谨的。提供一个生成随机数的接口，随机数全局唯一。调用接口的时候带入随机数。第一次调用，业务处理乐成后，将随机数作为key，操纵结果作为value，存入redis，同时设置逾期时长。第二次调用，查询redis，如果key存在，则证明是重复提交，直接返回错误。

三 数据规范题目


3.1 版本控制

一套成熟的API文档，一旦发布是不允许随意修改接口的。这时候如果想新增或者修改接口，就需要加入版本控制，版本号可以是整数类型，也可以是浮点数类型。一般接口所在都会带上版本号，http://ip:port//v1/list。

3.2 相应状态码规范

一个牛逼的API，还需要提供简单明了的相应值，根据状态码就可以大概知道题目所在。我们接纳http的状态码进行数据封装，例如200表示请求乐成，4xx表示客户端错误，5xx表示服务器内部发生错误。状态码设计参考如下：
分类描述1xx信息，服务器收到请求，需要请求者继续执行操纵2xx乐成3xx重定向，需要进一步的操纵以完成请求4xx客户端错误，请求包含语法错误或无法完成请求5xx服务端错误 状态码枚举类：
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 public enum CodeEnum {

    // 根据业务需求进行添加
    SUCCESS(200,"处理乐成"),
    ERROR_PATH(404,"请求所在错误"),
    ERROR_SERVER(505,"服务器内部发生错误");
     
    private int code;
    private String message;
     
    CodeEnum(int code, String message) {
        this.code = code;
        this.message = message;
    }

    public int getCode() {
        return code;
    }

    public void setCode(int code) {
        this.code = code;
    }

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }
}

3.3 统一相应数据格式

为了方便给客户端相应，相应数据会包含三个属性，状态码（code）,信息描述（message）,相应数据（data）。客户端根据状态码及信息描述可快速知道接口，如果状态码返回乐成，再开始处理数据。
相应结果定义及常用方法：
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 public class R implements Serializable {

    private static final long serialVersionUID = 793034041048451317L;

    private int code;
    private String message;
    private Object data = null;

    public int getCode() {
        return code;
    }
    public void setCode(int code) {
        this.code = code;
    }

    public String getMessage() {
        return message;
    }
    public void setMessage(String message) {
        this.message = message;
    }

    public Object getData() {
        return data;
    }

    /**
     * 放入相应枚举
     */
    public R fillCode(CodeEnum codeEnum){
        this.setCode(codeEnum.getCode());
        this.setMessage(codeEnum.getMessage());
        return this;
    }

    /**
     * 放入相应码及信息
     */
    public R fillCode(int code, String message){
        this.setCode(code);
        this.setMessage(message);
        return this;
    }

    /**
     * 处理乐成，放入自定义业务数据集合
     */
    public R fillData(Object data) {
        this.setCode(CodeEnum.SUCCESS.getCode());
        this.setMessage(CodeEnum.SUCCESS.getMessage());
        this.data = data;
        return this;
    }
}

总结

本篇文章从安全性、幂等性、数据规范等方面讨论了API设计规范。除此之外，一个好的API还少不了一个优秀的接口文档。接口文档的可读性非常重要，虽然很多程序员都不喜好写文档，而且不喜好别人不写文档。为了不增加程序员的压力，推荐使用swagger或其他接口管理工具，通过简单配置，就可以在开辟中测试接口的连通性，上线后也可以生成离线文档用于管理API。
 
总结：

感谢每一个认真阅读我文章的人！！！
作为一位过来人也是希望大家少走一些弯路，如果你不想再体验一次学习时找不到资料，没人解答题目，坚持几天便放弃的感受的话，在这里我给大家分享一些主动化测试的学习资源，希望能给你前进的路上带来帮助。

这份文档，对于想从事【软件测试】的朋侪来说应该是最全面最完整的备战仓库，这个仓库也伴随我走过了最艰难的路程，希望也能帮助到你！
   以上均可以分享，只需要你搜刮vx公众号：程序员雨果，即可免费领取

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。



欢迎光临 ToB企服应用市场:ToB评测及商务社交产业平台 (https://dis.qidao123.com/) Powered by Discuz! X3.4