接口规范

Restful规范L

一、  协议

API与用户的通信协议，总是使用HTTPs协议。

二、域名

应该尽量将API部署在专用域名之下。

https://api.example.com

如果确定API很简单，不会有进一步扩展，可以考虑放在主域名下。

https://example.org/api/

三、版本（Versioning）

应该将API的版本号放入URL。

https://api.example.com/api/v1/xxx

另一种做法是，将版本号放在HTTP头信息中，但不如放入URL方便和直观。Github采用这种做法。

四、路径（Endpoint）

路径又称"终点"（endpoint），表示API的具体网址。

在RESTful架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应。一般来说，数据库中的表都是同种记录的"集合"（collection），所以API中的名词也应该使用复数。

举例来说，有一个API提供动物园（zoo）的信息，还包括各种动物和雇员的信息，则它的路径应该设计成下面这样。

/zhttps://api.example.com/api/v1oos
https://api.example.com/api/v1/zoo/animals
https://api.example.com/api/v1/zoo/employees

假如某个resource是多个单词组成，使用下划线连接（尽量不出现多个单词的情况）

/api/v1/animal_park

五、HTTP动词

对于资源的具体操作类型，由HTTP动词表示。

常用的HTTP动词有下面五个（括号里是对应的SQL命令）。

GET：   从服务器取出资源（一项或多项）。
POST：  在服务器新建一个资源。
PUT：   在服务器更新资源（客户端提供改变后的完整资源）。
DELETE：从服务器删除资源。

还有几个不常用的HTTP动词。

PATCH：  在服务器更新资源（客户端提供改变的属性）。
HEAD：   获取资源的元数据。
OPTIONS：获取信息，关于资源的哪些属性是客户端可以改变的。

下面是一些例子。

GET /zoos：列出所有动物园
POST /zoo：新建一个动物园
GET /zoo?id=xxx：获取某个指定动物园的信息
PUT /zoo?id=xxx：更新某个指定动物园的信息（提供该动物园的全部信息）
PATCH /zoo?id=xxx：更新某个指定动物园的信息（提供该动物园的部分信息）
DELETE /zoo?id=xxx：删除某个动物园
GET /zoo/animals?zoo_id=xxx：列出某个指定动物园的所有动物
DELETE /zoo/animal?zoo_id=xxx&animal_id=xxx：删除某个指定动物园的指定动物

● 前端期望的是，获取列表资源，resource用复数形式，获取单个资源的详情，使用单数

六、查询字符串（params） 变量名使用下划线连接

/api/v1/zoos?limit=10&offset=10&sorted_by

七、请求体（body）传参全部使用JSON

使用JSON

{
    "name": "预报员1",
    "user_id": 123
}

不能出现以下情况

{
    "data1": "{'key1': 'value1'}",
    "data2": "[111, 222]"
}

八、状态码（Status Codes）

服务器向用户返回的状态码和提示信息，常见的有以下一些（方括号中是该状态码对应的HTTP动词）。

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 - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。这种情况一定要处理

● 如果请求成功，Status Code 不使用201、202等，统一使用200

● 请求失败参见第九条

状态码的完全列表参见这里。

九、错误处理（Error handling）

● 如果状态码是4xx，就应该向用户返回出错信息(code, msg)，方便做出具体的处理。

{
    "code": 40001,   # 自定义的
    "message": "Invalid API key"    # 错误信息
}

● 可以将用到过的code集中记录到指定文档中，方便别人查看

● Status Code不允许出现500

十、返回结果

针对不同操作，服务器向用户返回的结果可以参考以下。

注意：1. 最外层 "code" 、 "data" 及 "message"字段名不可以改变

    2. 空值，需要返回空数组或空对象

{
    "code": 200,
    "data": {}
}

GET /collection：返回资源对象的列表, 建议参考以下

{
    "code": 200,
    "data": {
        "total_count": 111,
        "data": [          
            {
                "name": "name123"
            },
            ...
        ]
    }
}

GET /collection/resource：返回单个资源对象

{
    "code": 200
    "data": {
        "name": "预报员1",
        ...
        }
}

POST /collection：返回新生成的资源对象或视具体业务需求而定

成功: 
{
    "code": 200
}
失败:
{
    "code": 40001,   # 自定义的
    "message": "Invalid API key"    # 错误提示
}

DELETE /collection/resource：返回如下或视具体业务需求而定

{
    "code": 200
}

十二、其他

（1）API的身份认证应该使用OAuth 2.0框架。

（2）服务器返回的数据格式，一律使用JSON，不使用XML及其他格式。

十三、接口文档模板

（一）获取动物园的所有动物

说明：(接口的补充解释说明，可以不写)

● url:  /api/v1/zoo/animals

● method: GET

● params:

字段	类型	说明	示例	是否必传
page_size	数字	每页条数	10	否
page_no	数字	页数	1	否

● response:

{
    "code": 200,
    "data": {
        "total_count": 111,            # 总条数
        "data": [          
            {
                "name": "name123",      # 名称
                "price": 12             # 价格
            },
            ...
        ]
    }
}

SOCKET规范

1.ws协议路由

ws://{{ip}}:{{port}}/ws/socket/*{{project_name}}

名称	说明
ip	地址
port	端口
project_name	项目名称（例子：vips5）

2.返回数据格式

注意：最外层 "code" 和 "data" 字段名不可以改变

{
     "code": 200,  
     "data": {
         {
             "model": "WRANING",
             "data": {
                 "message": "ok",                
                 "time": "2021-06-21 13:00:00", 
                 ...
             }
         }
     }
 }

名称	说明
model	模块
data	数据