当前位置: 首页 > article >正文

http(s)接口设计注意事项

http(s)在设计时应考虑:

一、签名认证

鉴权,如jwt方式等。

二、重要参数加密

如:用户的登录密码、银行卡号、转账金额、用户身份证等。

三、IP白名单

为了进一步加强API接口的安全性,防止接口的签名或者加密被破解了,攻击者可以在自己的服务器上请求该接口。

四、接口限流

如果API接口被第三方平台调用了,这就意味着着,调用频率是没法控制的。由此,需要对重要API接口做限流

五、参数校验与限制记录条数

如:校验必填字段是否为空,校验字段类型,校验字段长度,校验枚举值等等。这样做可以拦截一些无效的请求。

在Java中校验数据使用最多的是hiberateValidator框架,它里面包含了@Null、@NotEmpty、@Size、@Max、@Min等注解。用它们校验数据非常方便。

另外提供的批量接口,一定要限制请求的记录条数,如果请求的数据太多,很容易造成API接口超时等问题,让API接口变得不稳定。

六、统一返回值与统一封装异常

API网关捕获业务异常,然后转换成统一的异常结构返回,这样能统一返回值结构。

七、请求日志

最好有traceId,可以通过它串联整个请求的日志,过滤多余的日志。

八、幂等设计

支持在极短的时间内,第三方平台用相同的参数请求API接口多次,可能是bug或者接口重试,第一次请求数据库会新增数据,但第二次请求以后就不会新增数据,但也会返回成功。

高并发下可以通过乐观锁、加唯一索引等方法保证接口的幂等性。

高并发下如何保证接口的幂等性?

九、异步处理

一般的API接口的逻辑都是同步处理的,请求完之后立刻返回结果。对于非常复杂耗时的逻辑,则需要异步处理。

在API接口中可以发送一条mq消息,然后直接返回成功。之后,有个专门的mq消费者去异步消费该消息,做业务逻辑处理,如何通知调用方:

方法一:回调第三方平台的接口,告知API接口的处理结果,很多支付接口就是这么玩的。

方法二:第三方平台通过轮询调用我们另外一个查询状态的API接口,每隔一段时间查询一次状态,传入的参数是之前的那个API接口中的id集合。

十、数据脱敏

我们可以在返回的数据中,部分内容用星号代替。如:123****888

十一、压测

上线前我们对API接口做一下压力测试,知道各个接口的qps情况。


http://www.kler.cn/a/392690.html

相关文章:

  • docker:docker: Get https://registry-1.docker.io/v2/: net/http: request canceled
  • linux c/c++最高效的计时方法
  • qt QKeySequence详解
  • Microsoft 365 Exchange如何设置可信发件IP白名单
  • three.js 杂记
  • Jmeter基础篇(22)服务器性能监测工具Nmon的使用
  • 【大数据学习 | HBASE】hbase的读数据流程与hbase读取数据
  • 下载并安装Cmake3.29.5 windows安装包
  • HTTP常见的请求头有哪些?都有什么作用?在 Web 应用中使用这些请求头?
  • cmake生成器表达式
  • WordPress 6.7 “Rollins”发布
  • 成本400元,DIY一个高刷新率热成像相机
  • 使用 scipy 计算置信区间
  • 第N7周:调用Gensim库训练Word2Vec模型
  • 网络编程示例之开发板测试
  • java常用工具介绍
  • Prometheus面试内容整理-Metrics 类型
  • PHP接口安全的机制
  • 【代码管理之道】Git基础知识详解
  • 主成分分析(Principal Component Analysis, PCA) 数学原理 与 MATLAB代码复现
  • D67【python 接口自动化学习】- python基础之数据库
  • PostgreSQL 一键安装部署脚本化
  • html实体字符
  • 动态规划 —— dp 问题-买卖股票的最佳时机含冷冻期
  • Linux手动安装nginx
  • Vue全栈开发旅游网项目(11)-用户管理前端接口联调