《模板》API說明文檔

查詢區(qū)塊列表

接口功能

獲取系統(tǒng)中已錄入的所有區(qū)塊及描述

URL

GET /admin/block

響應(yīng)格式

JSON

返回參數(shù)
{
    "errorCode": 0,
    "message": "success",
    "data": [
        {
            "id": 21,
            "name": "首頁幻燈片", // 區(qū)塊名
            "description": "首頁幻燈片區(qū)塊,可進(jìn)行區(qū)塊的內(nèi)容管理", // 區(qū)塊描述
            "flag": "home" // 唯一標(biāo)識符,提供給開發(fā)者使用,方便代碼上線
            "createdAt": "2018-10-15 18:00:00", // 創(chuàng)建時間
            "updatedAt": "2018-10-15 18:00:00", // 更新時間
        },
        {
            "id": 22,
            "name": "首頁幻燈片2",
            "description": "首頁幻燈片區(qū)塊,可進(jìn)行區(qū)塊的內(nèi)容管理", 
            "flag": "home"
            "createdAt": "2018-10-15 18:00:00", // 創(chuàng)建時間
            "updatedAt": "2018-10-15 18:00:00", // 更新時間
        }
    ]
}

查詢區(qū)塊詳情

接口功能

獲取系統(tǒng)中指定某一區(qū)塊的詳情的接口

URL

GET /admin/block/{id}

響應(yīng)格式

JSON

返回參數(shù)
{
    "errorCode": 0,
    "message": "success",
    "data": [
        "id": 21,
        "name": "首頁幻燈片", // 區(qū)塊名
        "description": "首頁幻燈片區(qū)塊,可進(jìn)行區(qū)塊的內(nèi)容管理", // 區(qū)塊描述
        "flag": "home" // 唯一標(biāo)識符,提供給開發(fā)者使用,方便代碼上線
        "createdAt": "2018-10-15 18:00:00", // 創(chuàng)建時間
        "updatedAt": "2018-10-15 18:00:00", // 更新時間
    ]
}

創(chuàng)建、更新區(qū)塊

接口功能

創(chuàng)建、更新區(qū)塊信息的接口

URL

PUT /admin/block/{id} // 更新
POST /admin/block // 創(chuàng)建

響應(yīng)格式

JSON

接收參數(shù)
{
    "name": "首頁幻燈片", // 區(qū)塊名,字符串,長度限制:255
    "description": "首頁幻燈片區(qū)塊,可進(jìn)行區(qū)塊的內(nèi)容管理", // 區(qū)塊描述,字符串,長度限制:255
    "flag": "home" // 唯一標(biāo)識符,字符串,長度限制:255,提供給開發(fā)者使用,方便代碼上線
}
返回參數(shù)
{
    "errorCode": 0,
    "message": "success",
    "data": [
        "id": 21
    ]
}

刪除區(qū)塊

接口功能

刪除區(qū)塊的接口

URL

DELETE /admin/block

響應(yīng)格式

JSON

接收參數(shù)
{
    "ids": [ // 所要刪除區(qū)塊id,支持多區(qū)塊刪除
        21,
        22,
        23
    ]
}
返回參數(shù)
{
    "errorCode": 0,
    "message": "success",
    "data": []
}
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容