实现对外接口，要注意哪些问题前端php

做接口需要考虑的问题
什么是接口
接口无非就是客户端请求你的接口地址，并传入一堆该接口定义好的参数，通过接口自身的逻辑处理，返回接口约定好的数据以及相应的数据格式。
接口怎么开发
接口由于本身的性质，由于和合作方对接数据，所以有以下几点需要在开发的时候注意：
1、定义接口入参：写好接口文档
2、定义接口返回数据类型：一般都需要封装成一定格式，确定返回json还是xml报文等

文章图片

见如下返回数据定义格式：
Result

文章图片

Response

文章图片

3、确定访问接口的方式，get or post等等，可以根据restful接口定义规则RESTful API：RESTful API
4、定义一套全局统一并通用的返回码，以帮助排查问题；
reponse code

文章图片

【实现对外接口，要注意哪些问题】5、统一的异常处理：应该每个系统都需要一套统一的异常处理

文章图片

6、拦截器链设置：合作方访问接口的时候，会根据你接口定义好的传参访问你的接口服务器，但是会存在接口参数类型错误或者格式不对，必传参数没传的问题，甚至一些恶意请求，都可以通过拦截器链进行前期拦截，避免造成接口服务的压力。
还有很重要的一点，加签验签也可以在拦截器设置。继承WebMvcConfigurerAdapter实现springboot的拦截器链。实现HandlerInterceptor方法编写业务拦截器。
SignInterceptor

文章图片

文章图片

WebAppConfigurer

文章图片

文章图片

7、token令牌和sign数字签名实现数据保密性。
创建令牌（Token）
为保证请求的合法性，我们提供第三方创建令牌接口，某些接口需要通过token验证消息的合法性，以免遭受非法攻击。
token过期时间目前暂时定为1天，由于考虑到合作方往往是分布式环境，多台机器都有可能申请token，为了降低合作方保证token一致性的难度，调用接口创建token成功以后一分钟以内，再次请求token返回的数据是一样的。
获取私钥
获取用于数字签名的私钥，第三方获取的私钥需妥善保存，并定期更新，私钥只参与数字签名，不作为参数传输。
数字签名方式：
参数签名；签名方式：所有值不为null的参数（不包括本参数）均参与数字签名，按照“参数名+参数值+私钥”的格式得到一个字符串，再将这个字符串MD5一次就是这个参数的值。（示例：h15adc39y9ba59abbe56e057e60f883g），所以需要先获取私钥。
验签方式：
将用户的所有非null参数放入定义好排序规则的TreeSet中进行排序，再用StringBuilder按照按照“参数名+参数值+私钥”的格式得到一个字符串（私钥从redis拿），再将这个字符串MD5一次就是这个参数的值。将这个值与用户传来的sign签名对比，相同则通过，否则不通过。

文章图片

8、接口限流
有时候服务器压力真的太大，以防交易接口被挤死，就可以对一些其他不影响主要业务功能并且计算量大的接口做限流处理。RateLimit--使用guava来做接口限流，当接口超过指定的流量时，就不处理该接口的请求。
9、协议加密，http升级成https；
为什么要升级呢，为了保证数据的安全性。当使用https访问时，数据从客户端到服务断，服务端到客户端都加密，即使黑客抓包也看不到传输内容。当然还有其他好处，这里不多讲。但这也是开发接口项目需要注意的一个问题。
总结
下面对接口开发服务做一些总结：
1.拉还是推：
当接口作为数据源时，还要考虑数据是让合作方主动过来拉还是数据有变化就推送呢，当然是推的效果更好，但是如何有效的推数据，不推重复数据等都是需要根据实际业务考虑的问题。
2.多台分布式服务器上，怎么保证交易的幂等和订单的唯一性
当接口服务和合作方都处于分布式情况下，就很容易出现一个订单号申请多次交易请求，但是根据幂等性，一张彩票只能交易一次，并且每次不管何时请求，结果都应该一样不会改变。
这种情况下，我们怎么保证唯一性呢，我们需要把该订单和订单状态存redis，每次请求时去看是否订单已存在。但可能这次交易不成功，下次这张票还可以继续交易，可以生成新的订单号啊。
redis的setNX是一个很好的解决方案，意思是当存在该key时，返回false，当没有时，该key和value插入成功。用作检查订单是否正在提交，如果是，则阻塞本次请求，避免重复提交，可以设置过期时间3s。提交之前锁定订单，防止重复提交。
3.处理时间超过10s，自动返回该订单交易失败
总之，在高并发场景下，导致服务崩溃的原因还是redis和数据库，可能是redis读写太慢，或者数据库的一些sql使用不当，或者没建索引导致读写很慢。
如果你觉得这篇文章对你有点用的话，麻烦请给我们的开源项目点点star: http://github.crmeb.net/u/defu不胜感激！

实现对外接口，要注意哪些问题

推荐阅读

八图H5邀请函兴起的原因

中考志愿怎么填第一批第二批中考志愿怎么填

打完新冠疫苗要检查抗体吗

汽车发动机怠速不稳定是什么原因发动机怠速不稳定是什么原因有哪些

笔记本|ROG Zephyrus M16 性能全面升级，兼具台式机级性能

难忘的父亲节初中作文精选3篇

酷我音

广州陶瓷餐具价格怎么样广州陶瓷餐具哪里有卖

宜昌一次性吸纳就业补贴对象+电话宜昌市应届毕业生补贴

2022世界杯沙特阿拉伯队阵容名单世界杯沙特阿拉伯队首发阵容

高三优秀议论文优秀议论文

excel如何插入word文档

志高空调遥控器怎么调制热,注意这些控制技巧

步步惊心是什么意思步步惊心的含义

深圳北站在哪里打的深圳北站是哪里

信用卡欠了钱5万实在没钱还会坐牢吗

真后悔养了博美养博美犬的好处和坏处

大学期末考试试卷分析,试卷分析失分原因和改进措施

住房风水禁忌100例房屋后面风水禁忌

美的空调不同产地,每个人都应该了解这些