代码层面
规范的接口名称;规范的出入参名称;
明确的查询参数;明确的分页参数;严格的参数验证;
单一职责,确定本接口的业务边界;
安全层面
请求次数限制;请求数据限制;请求时间限制;
请求鉴权;
业务层面
明确本接口新增的业务含义;版本升级兼容;
是否需要幂等;是否需要加上监控;
是否满足性能要求;返回的数据是否满足业务的时效要求;
文档方面
准确的文档说明;及时的文档更新;样例数据的提供;
完善的状态码描述;
代码层面
规范的接口名称;规范的出入参名称;
明确的查询参数;明确的分页参数;严格的参数验证;
单一职责,确定本接口的业务边界;
安全层面
请求次数限制;请求数据限制;请求时间限制;
请求鉴权;
业务层面
明确本接口新增的业务含义;版本升级兼容;
是否需要幂等;是否需要加上监控;
是否满足性能要求;返回的数据是否满足业务的时效要求;
文档方面
准确的文档说明;及时的文档更新;样例数据的提供;
完善的状态码描述;