美文网首页
API 自查清单

API 自查清单

作者: 刘月玮 | 来源:发表于2017-07-17 09:46 被阅读8次
    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. 检查返回值形式是否与数据库形式相同,要表意明确

    相关文章

      网友评论

          本文标题:API 自查清单

          本文链接:https://www.haomeiwen.com/subject/fakfkxtx.html