URI 命名是否通过聚合根和实体统一
URI 命名是否采用名词复数和连接线
URI 命名是否都是单词小写
URI 是否暴露了不必要的信息，例如 /cgi-bin
URI 规则是否统一
资源提供的能力是否彼此独立
URI 是否存在需要编码的字符
请求和返回的参数是否不多不少
资源的 ID 参数是否通过 PATH 参数传递
认证和授权信息是否暴露到 query 参数中
参数是否使用奇怪的缩写
参数和响应数据中的字段命名统一
是否存在无意义的对象包装 例如 {"data":{}'}
出错时是否破坏约定的数据结构
是否使用合适的状态码
是否使用合适的媒体类型
响应数据的单复是否和数据内容一致
响应头中是否有缓存信息
是否进行了版本管理
版本信息是否作为 URI 的前缀存在
是否提供 API 服务期限
是否提供了 API 返回所有 API 的索引
是否进行了认证和授权
是否采用 HTTPS
是否检查了非法参数
是否增加安全性的头部
是否有限流策略
是否支持 CORS
响应中的时间格式是否采用 ISO 8601 标准
是否存在越权访问
URI 命名是否通过聚合根和实体统一 URI 命名是否采用名词复数和连接线 URI 命名是否都是单词小写 URI ...
1. 为什么要建自查/评审清单 设计评审评审的通常是任务流程的完整度流畅度，交互细节是否完善，特殊状态的描述是否遗...
评审形式主要有两种：设计组内评审、项目组评审 设计组内评审 设计组内评审的意义主要在于确保方案合理与完整性，主要针...
需求确认>>需求优先级>>产品设计>>prd文档的编写>>prd评审>>UI设计>>UI评审>>研发技术评审>>需...
UI评审 [what] 什么是UI评审？优秀的设计评审是探索整个设计过程，找到亮点并发掘改进机会。Harlan E...
做设计评审的主导者： 如果设计师无法主导评审会，原本完整的设计方案很可能会被各种意见影响，变得面目全非。 设计评审...
软件工程流程以及工具整理 产品设计 文档管理 禅道 设计评审 禅道 开发设计 设计文档 禅道 设计评审 软件开发 ...
Web API的设计与开发 说明 丰富了附录B中的Web API检查清单，给予了一些必要的解释与说明，方便大家快速...
需求阶段 需求文档经外部评审通过干系人在评审报告签字，发布基线； 设计阶段： 设计设计文档（总体方案、概设、详设、...
API设计 Google API 设计思想 1、设计 API设计原则简单可用一致 HTTP 常用方法get 获...
本文标题：API 设计评审清单
本文链接：https://www.haomeiwen.com/subject/vpvnsktx.html
网友评论