《模板》API说明文档

查询区块列表

接口功能

获取系统中已录入的所有区块及描述

URL

GET /admin/block

响应格式

JSON

返回参数

{
    "errorCode": 0,
    "message": "success",
    "data": [
        {
            "id": 21,
            "name": "首页幻灯片", // 区块名
            "description": "首页幻灯片区块，可进行区块的内容管理", // 区块描述
            "flag": "home" // 唯一标识符，提供给开发者使用，方便代码上线
            "createdAt": "2018-10-15 18:00:00", // 创建时间
            "updatedAt": "2018-10-15 18:00:00", // 更新时间
        },
        {
            "id": 22,
            "name": "首页幻灯片2",
            "description": "首页幻灯片区块，可进行区块的内容管理", 
            "flag": "home"
            "createdAt": "2018-10-15 18:00:00", // 创建时间
            "updatedAt": "2018-10-15 18:00:00", // 更新时间
        }
    ]
}

---

查询区块详情

接口功能

获取系统中指定某一区块的详情的接口

URL

GET /admin/block/{id}

响应格式

JSON

返回参数

{
    "errorCode": 0,
    "message": "success",
    "data": [
        "id": 21,
        "name": "首页幻灯片", // 区块名
        "description": "首页幻灯片区块，可进行区块的内容管理", // 区块描述
        "flag": "home" // 唯一标识符，提供给开发者使用，方便代码上线
        "createdAt": "2018-10-15 18:00:00", // 创建时间
        "updatedAt": "2018-10-15 18:00:00", // 更新时间
    ]
}

---

创建、更新区块

接口功能

创建、更新区块信息的接口

URL

PUT /admin/block/{id} // 更新
POST /admin/block // 创建

响应格式

JSON

接收参数

{
    "name": "首页幻灯片", // 区块名，字符串，长度限制：255
    "description": "首页幻灯片区块，可进行区块的内容管理", // 区块描述，字符串，长度限制：255
    "flag": "home" // 唯一标识符，字符串，长度限制：255，提供给开发者使用，方便代码上线
}

返回参数

{
    "errorCode": 0,
    "message": "success",
    "data": [
        "id": 21
    ]
}

---

删除区块

接口功能

删除区块的接口

URL

DELETE /admin/block

响应格式

JSON

接收参数

{
    "ids": [ // 所要删除区块id，支持多区块删除
        21,
        22,
        23
    ]
}

返回参数

{
    "errorCode": 0,
    "message": "success",
    "data": []
}