如何制定平台接口建设标准规范？

本文共计2728个文字，预计阅读时间需要11分钟。

构建目标+平台接口设计规范：为接口开发、测试、使用规划一个框架，明确技术目标与需求，并要求提供详尽的接口文档说明，确保自有平台与第三方平台提供的数据及服务支持。

建设目标

平台接口建设规范旨在为接口开发、测试、使用划定一个框架边界，明确技术目标与要求，并要求提供完备的接口文档说明，为自有平台与第三方平台提供数据及服务支持。

建设标准 接口规范 命名规范

在标准的RESTful架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词。

根据观察大多数平台在接口设计当中，都无法完全按照此规范，这里我的建议是无论接口命名还是参数命名必须基于业务与理解需要进行合理设计，确保简洁务实、便于理解。

幂等性

幂等性是指任意多次请求的执行结果和一次请求的执行结果所产生的影响相同。查询操作无论查询多少次都不会影响数据本身，因此查询操作本身就是幂等的。但是新增操作，每执行一次数据库就会发生变化，所以它是非幂等的。

关于幂等性的实现方式有很多种，比如前端禁用、参数传入唯一Key值或者先查询后操作等，这里不做详细概述。一般来说接口中新增操作、部分带条件的删除和修改操作都是要考虑幂等性的，这也是保证数据一致性和安全性的必要措施。