Restful接口规范

Restful接口规范

一、简介

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

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

二、URL设计

2.1 数据的安全保障

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

    注：采用https协议，可以提高数据交互过程中的安全性(ssl加密)

2.2 接口特征表现

2.3 多数据版本共存

2.4 数据即是资源

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

三.响应状态码

3.1 正常响应

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

3.2 重定向响应

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

3.3 客户端异常

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

3.4 服务器异常

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

四、响应结果

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

  • 0真，1假
  • msg状态信息
  • results数据本身
{
    "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"
        }
        ...
        ]
}

五、总结

  1. url设计

    1. 数据的安全保障
      • url连接采用https协议,进行传输
    2. 接口特征的表现
    3. 数据版本设计，第一代，第二代
    4. 数据接口请求资源的url设计,一般提倡复数的形式，禁止出现操作资源的动词，特殊情况的接口可以出现动词
    5. 请求资源的请求方式url设计，增删改查，获取单查群查，实现十大接口功能等

  2. 响应状态码

    1. 请求正常响应，200常规请求，201创建成功

  3. 重定向响应：301：永久重定向，302：暂时重定向
    3. 客户端异常：403：请求无权限，404请求路径不存在，405请求方法不存在

  4. 服务器异常响应：500：服务器异常

  5. 响应结果

    1. 响应数据要有状态码，状态信息，响应数据本身
    2. 状态码：status: 0成功，1：失败
    3. 状态信息：msg: "ok", "error"
    4. 响应数据本身:results: "列表"，"字典"

​

posted @ 2019-11-24 21:09  RandySun  阅读(369)  评论(0)  编辑  收藏  举报