基于RESTful风格的数据接口规范

版本控制常用的三种方法

1、URL

    目录

     http://eg.com/api/v1

     http://eg,com/api/v2

   域名

     http://v1.eg.com

     http://v2.eg.com

 

2、自定义请求头

3、Accept标头

 

确定HTTP的方法

    RESTful中的HTTP方法：

        GET、POST、PUT（全部修改）、DELETE、HEAD、PATCH（部分修改）、OPTIONS

 

HTTP的返回状态

    200 成功、400错误请求、404没找到资源、403禁止、406请求内容特性无法响应请求资源、500服务器出错

 

备注：统一的JSON格式可保障前后端数据的交互式顺畅

    E.G.

        异常/错误

         {

               "code": 10001,

               "msg": "异常信息",

               "data": null
          }

        成功

        {

              "code": 200,

              "msg": "成功",

              "data": {

                 "id": 1,

                 "name": "lly",

                 "age": 2

              }

         }