API接口设计规范

WAL(Write Ahead Log)，即预写日志，是数据库系统中常见的一种手段，用于保证数据操作的原子性和持久性。在使用WAL的应用系统中(如MySQL)，所有的修改在提交之前都要先写入log文件中，log文件中通常包括redo和undo信息。

一、概念

二、使用

接口地址 https://liusir.me/v1/products
- 协议
  - http
  - https
- 域名
  - 测试环境liusir.me
  - 生产环境test.liusir.me
- 版本
  - 整数：大版本号，如：v1,v2，具有当前版本下的所有API接口
  - 浮点数：小版本号，只具备补充API的功能，其他API都默认调用对应大版本号，如：v1.1,v2.2
地址
- RESTful格式：地址代表一种资源(resource)，所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应。一般来说，数据库中的表都是同种记录的集合(collection，所以API中的名词也应该使用复数。
- 非RESTful格式：本着见文知意的原则，可getDataList，get-data-list，data:list等形式
请求
- 请求方式
  - GET(SELECT)：从服务器取出资源，可一项或多项。
  - POST(CREATE)：在服务器新建一个资源。
  - PUT(UPDATE)：在服务器更新资源(客户端提供改变后的完整资源)。
  - DELETE(DELETE)：从服务器删除资源。
- 请求参数
  - 通过地址栏传参
  - 通过请求体传参
  - 通过请求header传参

响应

响应结果

{
    "status": true,
    "type": "json",
    "code": "001",
    "result": {
        "total": 2,
        "total_page": 1,
        "data": [
            {
                "id": "12345",
                "student_no": "12345",//学员学号
                "student_name": "测试",//学员姓名
            },
            {
                "id": "12345",
                "student_no": "12345",//学员学号
                "student_name": "测试",//学员姓名
            },
        ]
    }
}

错误码说明

错误码	描述
001	请求成功

一、概念

二、使用

三、参考