Restful API 具体设计规范(概述)

84 阅读1分钟
  1. 协议

    https

  2. 域名

    https://www.baidu.com/api

  3. 版本

    https://www.baidu.com/v1

  4. 路径

    https://www.baidu.com/v1/blogs

  5. 方法

image.png

  1. 数据过滤

image.png

  1. 状态码
  2. 返回结果

image.png

  1. 返回的数据格式

    尽量使用 JSON,避免使用 XML。

总结:

  1. 看 url 就知道要什么
  2. 看 http method 就知道干什么
  3. 看 http status 就知道结果如何