1.简介

2000年Roy Fielding博士在其博士论文中提出REST(Representational State Transfer)风格的软件架构模式后,REST就基本上迅速取代了复杂而笨重的SOAP,成为Web API的标准了。

RESTful作为目前最流行的 API 设计规范,一定有着它独有的魅力:强大、简介、易上手。

2.URL设计

2.1 数据的安全保障

  • url链接一般都采用https协议进行传输

    注:采用https协议,可以提高数据交互过程中的安全性

2.2 接口特征表现

  • 用api关键字标识接口url:

  • https://api.baidu.com
    https://www.baidu.com/api

     

  • 注:看到api字眼,就代表该请求url链接是完成前后台数据交互的

2.3 多数据版本共存

  • 在url链接中标识数据版本

  • https://api.baidu.com/v1
    https://api.baidu.com/v2

     

  • 注:url链接中的v1、v2就是不同数据版本的体现(只有在一种数据资源有多版本情况下)

2.4 数据即是资源

  • 接口一般都是完成前后台数据的交互,交互的数据我们称之为资源

  • https://api.baidu.com/users
    https://api.baidu.com/books
    https://api.baidu.com/book

     

  • 注:一般提倡用资源的复数形式,在url链接中奖励不要出现操作资源的动词,错误示范:https://api.baidu.com/delete-user

  • 特殊的接口可以出现动词,因为这些接口一般没有一个明确的资源,或是动词就是接口的核心含义

 

https://api.baidu.com/place/search
https://api.baidu.com/login

 

2.5 资源操作由请求方式决定

  • 操作资源一般都会涉及到增删改查,我们提供请求方式来标识增删改查动作
https://api.baidu.com/books - get请求:获取所有书
https://api.baidu.com/books/1 - get请求:获取主键为1的书
https://api.baidu.com/books - post请求:新增一本书书
https://api.baidu.com/books/1 - put请求:整体修改主键为1的书
https://api.baidu.com/books/1 - patch请求:局部修改主键为1的书
https://api.baidu.com/books/1 - delete请求:删除主键为1的书

 

3.响应状态码

3.1 正常响应

  • 响应状态码2xx
    • 200:常规请求
    • 201:创建成功

3.2 重定向响应

  • 响应状态码3xx
    • 301:永久重定向
    • 302:暂时重定向

3.3 客户端异常

  • 响应状态码4xx
    • 403:请求无权限
    • 404:请求路径不存在
    • 405:请求方法不存在

3.4 服务器异常

  • 响应状态码5xx
    • 500:服务器异常

4.响应结果

4.1 响应数据要有状态码、状态信息以及数据本身

{
      "status": 0,
      "msg": "ok",
      "results":[
        {
            "name":"肯德基(罗餐厅)",
            "location":{
                "lat":31.415354,
                "lng":121.357339
            },
            "address":"月罗路2380号",
            "province":"上海市",
            "city":"上海市",
            "area":"宝山区",
            "street_id":"339ed41ae1d6dc320a5cb37c",
            "telephone":"(021)56761006",
            "detail":1,
            "uid":"339ed41ae1d6dc320a5cb37c"
        }
          ...
        ]
}

 

4.2 需要url请求的资源需要访问资源的请求链接

{
      "status": 0,
      "msg": "ok",
      "results":[
        {
            "name":"肯德基(罗餐厅)",
            "img": "https://image.baidu.com/kfc/001.png"
        }
          ...
        ]
}

 

声明:本站所有文章,如无特殊说明或标注,均为本站原创发布。任何个人或组织,在未征得本站同意时,禁止复制、盗用、采集、发布本站内容到任何网站、书籍等各类媒体平台。如若本站内容侵犯了原著者的合法权益,可联系我们进行处理。