如何优雅的设计RESTful API

思考几个问题​
1. 为什么要有规范?​
2. 如何让前后端快速开发、联调?

一些概念​

URI和URL的区别​

http状态码的含义​

Http method的含义​

什么是RESTful​

定义​

设计原则​

URI设计​

状态码的使用​

请求和响应体的设计​

异常处理​

安全性的考虑​

文档​

超媒体驱动的 API(HATEOAS)​

场景举例​

查询用户列表(带条件)​

获取用户​

删除用户​

修改用户状态​

批量修改某一个用户的属性​

查询用户关联的机器狗​

附录​

优秀案例​

  1. GitHub​
  2. Swagger​

工具​

  1. Spring HATEOAS:点我

示例代码

文章目录
  1. 1. 一些概念​
    1. 1.1. URI和URL的区别​
    2. 1.2. http状态码的含义​
    3. 1.3. Http method的含义​
  2. 2. 什么是RESTful​
    1. 2.1. 定义​
    2. 2.2. 设计原则​
      1. 2.2.1. URI设计​
      2. 2.2.2. 状态码的使用​
      3. 2.2.3. 请求和响应体的设计​
      4. 2.2.4. 异常处理​
      5. 2.2.5. 安全性的考虑​
      6. 2.2.6. 文档​
      7. 2.2.7. 超媒体驱动的 API(HATEOAS)​
  3. 3. 场景举例​
    1. 3.1. 查询用户列表(带条件)​
    2. 3.2. 获取用户​
    3. 3.3. 删除用户​
    4. 3.4. 修改用户状态​
    5. 3.5. 批量修改某一个用户的属性​
    6. 3.6. 查询用户关联的机器狗​
  4. 4. 附录​
    1. 4.1. 优秀案例​
    2. 4.2. 工具​
    3. 4.3. 示例代码
评论
Powered By Valine
v1.5.2