Restful API 介绍

1. 简介

• RESTful： Representational State Transfer（表象层状态转变）， 目前最流行的 API 设计规范，用于 Web 数据接口的设计

2. 特点

2.1 URL

• 使用https协议
• 尽量使用域名
• 多版本是以版本号进行区分
• 一般使用复数
• 请求路径后一般带有过滤参数
• 常用方法：GET/POST/PUT(全量修改)/DELETE

https://example.com/api/v1/projects?page=2&per_page=100   GET    获取所有项目
https://example.com/api/v1/projects/1 GET    获取id=1的项目信息
https://example.com/api/v1/projects   POST   创建项目
https://example.com/api/v1/projects/1 PUT    修改id=1的项目
https://example.com/api/v1/projects/1 DELETE 删除id=1的项目 

2.2 响应

• 一般统一为json/xml格式
• 响应状态码
  • 200 OK - [GET]：服务器成功返回用户请求的数据，该操作是幂等的（Idempotent）
  • 201 CREATED - [POST/PUT/PATCH]：用户新建或修改数据成功。
  • 202 Accepted - [*]：表示一个请求已经进入后台排队（异步任务）
  • 204 NO CONTENT - [DELETE]：用户删除数据成功。
  • 400 INVALID REQUEST - [POST/PUT/PATCH]：用户发出的请求有错误，服务器没有进行新建或修改数据的操作，该操作是幂等的。
  • 401 Unauthorized - [*]：表示用户没有权限（令牌、用户名、密码错误）。
  • 403 Forbidden - [*] 表示用户得到授权（与401错误相对），但是访问是被禁止的。
  • 404 NOT FOUND - [*]：用户发出的请求针对的是不存在的记录，服务器没有进行操作，该操作是幂等的。
  • 406 Not Acceptable - [GET]：用户请求的格式不可得（比如用户请求JSON格式，但是只有XML格式）。
  • 410 Gone -[GET]：用户请求的资源被永久删除，且不会再得到的。
  • 422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时，发生一个验证错误。
  • 500 INTERNAL SERVER ERROR - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。
• 响应结果中可能带有路径，如上一页/下一页路径

# 正确响应
{
    
    
  "code": 200,
  "message": "success",
  "data": {
    
    
    "userName": "123456",
    "age": 16,
    "address": "beijing"
  }
}
# 错误响应

{
    
    
  "code": 401,
  "message": "error  message",
  "data": ""
}