后端接口的开发思路.pdfVIP

后端接口的开发思路

1.确定接口需求

与前端开发人员沟通，了解他们需要哪些接口以及接口的参数、返回值信

息。

2.考虑接口的可扩展性

确认好需求后，根据实际业务场景设计接口，充分考虑接口的可扩展性。

比如有个需求：是用户添加或者修改员工信息，你要考虑用户的密码是不是

也在接口中直接修改，还是需要建立一个通用的修改接口标准，其他修改信息

直接复用这个接口。

使用版本控制：在接口中添加版本号可以使得接口具有更好的兼容性和可扩

展性，同时也方便对接口进行升级和维护。

使用抽象数据结构：使用抽象数据结构可以使接口更加通用和可扩展，可以

适应不同类型的数据C

3.根据接口需求，设计接口的结构，包括接口的URL、请求方式、参数等。

接口结构的设计：一般分为两种，一种是调用方约定结构方式。

二是做为接口设计方设计标准的报文结构格式，调用方必须采用该结构方式

调用。

设计参数：根据接口功能和客户端需求，设计合适的参数，包括必选参数、

可选参数、路径参数、查询参数。

设计返回值：根据接口功能和前端需求，设计合适的返回值，包括状态码、

响应头、响应体。接口状态和错误需要统一明确。

状态码：一般定好一些标准的状态码，比如code=0000-代表报文请求成功，

Code二9999-代表报文请求失败。

确定请求方式：根据接口功能和数据安全性要求，选择合适的请求方式，例

如ET、POST、PUT、DELETE。

4.接口参数验证

你设计的接口，必须先校验参数。比如人参是否允许为空，入参长度是否符

合你的预期长度，这些都是接口的必备项，出参也是，比如你定义的接口报文，

参数是不为空的，但是你的接口返回参数，没有做校验。

5.接口是否需要防重处理

如果客户端重复请求，你的逻辑如何处理？是不是考虑接口去重处理。

如果是查询类的请求，不需要防重。如果是更新修改类的话，尤其金融转账

类的，就要过滤重复请求了。

6.调用第三方接口要考虑异常和超时处理

如果你调用第三方接口，或者分布式远程服务的的话，需要考虑：

异常处理

比如，你调别人的接口，如果异常了，怎么处理，是重试还是当做失败还是

告警处理。

接口超时

没法预估对方接口一般多久返回，一般设置个超时断开时间，以保护你的接

口。之前见过一个生产问题，就走http调用不设置超时时间，最后响应方进程

假死，请求一直占着线程不释放，拖垮线程池。

重试次数

你的接口调失败，需不需要重试？重试几次？需要站在业务上角度思考这个

问题。

7.日志设计

日志是一个系统的关键，所以接口设计的时侯日志保存是必须要考虑的，要

考虑