API 自查清单

  1. url 命名，主要基于《规范》，主要排查：
    1. 是否表意正确；
      1. 力求表意一眼就能看懂，不关心具体实现逻辑
      2. Path 传参数：资源/资源ID，比如苹果/苹果ID, 梨子/梨子ID，必须严格遵循。
      3. 命名要采用通用标准，比如 url 中的 check 要加就统一加，不加就统一不加。
    2. 是否有冗余
    3. 大小写、单复数
    4. description 是否足够表意或有冗余
  2. put/get/post
    1. 是否用对相应的操作方式
    2. 对应输入输出采用的数据格式等是否符合《规范》要求
  3. parameters in
    1. 内容是否缺失或多余
    2. path/query/body 是否选对
    3. type
    4. description
    5. 大小写、单复数
  4. response
    1. 内容是否缺失或多余
    2. path/query/body 是否选对
    3. type
    4. description
    5. 大小写、单复数
    6. 检查返回值形式是否与数据库形式相同，要表意明确
最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
平台声明：文章内容（如有图片或视频亦包括在内）由作者上传并发布，文章内容仅代表作者本人观点，简书系信息发布平台，仅提供信息存储服务。

推荐阅读更多精彩内容