天天看點

postman接口文檔

  1. api

    基準路徑:http://localhost:8888/api/private/v1/

    除了登入接口,其他所有接口請求頭必須設定為Authorization=token (token為登入成功後伺服器傳回的認證token)

    1.1. 登入

    1.1.1. 登入驗證接口

    請求路徑:login

    請求方法:post

    請求參數

    參數名 參數說明 備注

    username 使用者名 不能為空

    password 密碼 不能為空

    響應參數

    參數名 參數說明 備注

    id 使用者ID

    rid 使用者角色ID

    username 使用者名

    mobile 手機号

    email 郵箱

    token 令牌 基于jwt的令牌

    響應資料

    {

    “data”: {

    “id”: 500,

    “rid”: 0,

    “username”: “admin”,

    “mobile”: “123”,

    “email”: "[email protected]",

    “token”: “Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1aWQiOjUwMCwicmlkIjowLCJpYXQiOjE1MTI1NDQyOTksImV4cCI6MTUxMjYzMDY5OX0.eGrsrvwHm-tPsO9r_pxHIQ5i5L1kX9RX444uwnRGaIM”

    },

    “meta”: {

    “msg”: “登入成功”,

    “status”: 200

    }

    }

    1.2. 使用者管理

    1.2.1. 使用者資料清單

    請求路徑:users

    請求方法:get

    請求參數

    參數名 參數說明 備注

    query 查詢參數 可以為空

    pagenum 目前頁碼 不能為空

    pagesize 每頁顯示條數 不能為空

    響應參數

    參數名 參數說明 備注

    totalpage 總記錄數

    pagenum 目前頁碼

    users 使用者資料集合

    響應資料

    {

    “data”: {

    “totalpage”: 5,

    “pagenum”: 4,

    “users”: [

    {

    “id”: 25,

    “username”: “tige117”,

    “mobile”: “18616358651”,

    “type”: 1,

    “openid”: “”,

    “email”: "[email protected]",

    “create_time”: “2017-11-09T20:36:26.000Z”,

    “modify_time”: null,

    “is_delete”: false,

    “is_active”: false

    }

    ]

    },

    “meta”: {

    “msg”: “擷取成功”,

    “status”: 200

    }

    }

    1.2.2. 添加使用者

    請求路徑:users

    請求方法:post

    請求參數

    參數名 參數說明 備注

    username 使用者名稱 不能為空

    password 使用者密碼 不能為空

    email 郵箱 可以為空

    mobile 手機号 可以為空

    響應參數

    參數名 參數說明 備注

    id 使用者ID

    rid 使用者角色ID

    username 使用者名

    mobile 手機号

    email 郵箱

    響應資料

    {

    “data”: {

    “id”: 28,

    “username”: “tige1200”,

    “mobile”: “test”,

    “type”: 1,

    “openid”: “”,

    “email”: "[email protected]",

    “create_time”: “2017-11-10T03:47:13.533Z”,

    “modify_time”: null,

    “is_delete”: false,

    “is_active”: false

    },

    “meta”: {

    “msg”: “使用者建立成功”,

    “status”: 201

    }

    }

    1.2.3. 修改使用者狀态

    請求路徑:users/:uId/state/:type

    請求方法:put

    請求參數

    參數名 參數說明 備注

    uId 使用者ID 不能為空攜帶在url中

    type 使用者狀态 不能為空攜帶在url中,值為true或者false

    響應資料

    {

    “data”: {

    “id”: 566,

    “rid”: 30,

    “username”: “admin”,

    “mobile”: “123456”,

    “email”: "[email protected]",

    “mg_state”: 0

    },

    “meta”: {

    “msg”: “設定狀态成功”,

    “status”: 200

    }

    }

    1.2.4. 根據ID查詢使用者資訊

    請求路徑:users/:id

    請求方法:get

    請求參數

    參數名 參數說明 備注

    id 使用者ID 不能為空攜帶在url中

    響應參數

    參數名 參數說明 備注

    id 使用者ID

    role_id 角色ID

    mobile 手機号

    email 郵箱

    響應資料

    {

    “data”: {

    “id”: 503,

    “username”: “admin3”,

    “role_id”: 0,

    “mobile”: “00000”,

    “email”: "[email protected]"

    },

    “meta”: {

    “msg”: “更新成功”,

    “status”: 200

    }

    }

    1.2.5. 編輯使用者送出

    請求路徑:users/:id

    請求方法:put

    請求參數

    參數名 參數說明 備注

    id 使用者id 不能為空 參數是url參數:id

    email 郵箱 可以為空

    mobile 手機号 可以為空

    響應參數

    參數名 參數說明 備注

    id 使用者ID

    role_id 角色ID

    mobile 手機号

    email 郵箱

    響應資料

    {

    “data”: {

    “id”: 503,

    “username”: “admin3”,

    “role_id”: 0,

    “mobile”: “111”,

    “email”: "[email protected]"

    },

    “meta”: {

    “msg”: “更新成功”,

    “status”: 200

    }

    }

    1.2.6. 删除單個使用者

    請求路徑:users/:id

    請求方法:delete

    請求參數

    參數名 參數說明 備注

    id 使用者id 不能為空參數是url參數:id

    響應參數

    響應資料

    {

    “data”: null,

    “meta”: {

    “msg”: “删除成功”,

    “status”: 200

    }

    }

    1.2.7. 配置設定使用者角色

    請求路徑:users/:id/role

    請求方法:put

    請求參數

    參數名 參數說明 備注

    id 使用者ID 不能為空參數是url參數:id

    rid 角色id 不能為空參數body參數

    響應參數

    參數名 參數說明 備注

    id 使用者ID

    role_id 角色ID

    mobile 手機号

    email 郵箱

    響應資料

    {

    “data”: {

    “id”: 508,

    “rid”: “30”,

    “username”: “asdf1”,

    “mobile”: “123123”,

    “email”: "[email protected]"

    },

    “meta”: {

    “msg”: “設定角色成功”,

    “status”: 200

    }

    }

    1.3. 權限管理

    1.3.1. 所有權限清單

    請求路徑:rights/:type

    請求方法:get

    請求參數

    參數名 參數說明 備注

    type 類型 值: list 或 tree , list 清單顯示權限, tree 樹狀顯示權限,參數是url參數:type

    響應參數

    參數名 參數說明 備注

    id 權限ID

    authName 權限說明

    level 權限層級

    pid 權限父ID

    path 對應通路路徑

    響應資料 type=list

    {

    “data”: [

    {

    “id”: 101,

    “authName”: “商品管理”,

    “level”: “0”,

    “pid”: 0,

    “path”: null

    },

    {

    “id”: 102,

    “authName”: “訂單管理”,

    “level”: “0”,

    “pid”: 0,

    “path”: null

    }

    ],

    “meta”: {

    “msg”: “擷取權限清單成功”,

    “status”: 200

    }

    }

    type=tree

    [

    {

    “data”: [

    {

    “id”: 101,

    “authName”: “商品管理”,

    “path”: null,

    “pid”: 0,

    “children”: [

    {

    “id”: 104,

    “authName”: “商品清單”,

    “path”: null,

    “pid”: 101,

    “children”: [

    {

    “id”: 105,

    “authName”: “添加商品”,

    “path”: null,

    “pid”: “104,101”

    }

    ]

    }

    ]

    }

    ],

    “meta”: {

    “msg”: “擷取權限清單成功”,

    “status”: 200

    }

    }

    ]

    1.3.2. 左側菜單權限

    請求路徑:menus

    請求方法:get

    響應資料

    {

    “data”: [

    {

    “id”: 101,

    “authName”: “商品管理”,

    “path”: null,

    “children”: [

    {

    “id”: 104,

    “authName”: “商品清單”,

    “path”: null,

    “children”: []

    }

    ]

    }

    “meta”: {

    “msg”: “擷取菜單清單成功”,

    “status”: 200

    }

    }

    1.4. 角色管理

    1.4.1. 角色清單

    請求路徑:roles

    請求方法:get

    響應資料說明

    o第一層為角色資訊

    o第二層開始為權限說明,權限一共有3層權限

    響應資料

    {

    “data”: [

    {

    “id”: 30,

    “roleName”: “主管”,

    “roleDesc”: “技術負責人”,

    “children”: [

    {

    “id”: 101,

    “authName”: “商品管理”,

    “path”: null,

    “children”: [

    {

    “id”: 104,

    “authName”: “商品清單”,

    “path”: null,

    “children”: [

    {

    “id”: 105,

    “authName”: “添加商品”,

    “path”: null

    }

    ]

    }

    ]

    }

    ]

    }

    ],

    “meta”: {

    “msg”: “擷取成功”,

    “status”: 200

    }

    }

    1.4.2. 添加角色

    請求路徑:roles

    請求方法:post

    請求參數

    參數名 參數說明 備注

    roleName 角色名稱 不能為空

    roleDesc 角色描述 可以為空

    響應參數

    參數名 參數說明 備注

    roleId 角色ID

    roleName 角色名稱

    roleDesc 角色描述

    響應資料

    {

    “data”: {

    “roleId”: 40,

    “roleName”: “admin2”,

    “roleDesc”: “admin2Desc”

    },

    “meta”: {

    “msg”: “建立成功”,

    “status”: 201

    }

    }

    1.4.3. 根據ID查詢角色

    請求路徑:roles/:id

    請求方法:get

    請求參數

    參數名 參數說明 備注

    :id 角色ID 不能為空攜帶在url中

    響應參數

    參數名 參數說明 備注

    roleId 角色ID

    roleName 角色名稱

    roleDesc 角色描述

    響應資料

    {

    “data”: {

    “roleId”: 31,

    “roleName”: “測試角色”,

    “roleDesc”: “測試負責人”

    },

    “meta”: {

    “msg”: “擷取成功”,

    “status”: 200

    }

    }

    1.4.4. 編輯送出角色

    請求路徑:roles/:id

    請求方法:put

    請求參數

    參數名 參數說明 備注

    :id 角色ID 不能為空攜帶在url中

    roleName 角色名稱 不能為空

    roleDesc 角色描述 可以為空

    響應資料

    {

    “data”: {

    “roleId”: 31,

    “roleName”: “測試角色”,

    “roleDesc”: “測試角色描述”

    },

    “meta”: {

    “msg”: “擷取成功”,

    “status”: 200

    }

    }

    1.4.5. 删除角色

    請求路徑:roles/:id

    請求方法:delete

    請求參數

    參數名 參數說明 備注

    :id 角色ID 不能為空攜帶在url中

    響應資料

    {

    “data”: null,

    “meta”: {

    “msg”: “删除成功”,

    “status”: 200

    }

    }

    1.4.6. 角色授權

    請求路徑:roles/:roleId/rights

    請求方法:post

    請求參數

    參數名 參數說明 備注

    :roleId 角色ID 不能為空攜帶在url中

    rids 權限ID清單 以 , 分割的權限ID清單

    響應資料

    {

    “data”: null,

    “meta”: {

    “msg”: “更新成功”,

    “status”: 200

    }

    }

    1.4.7. 删除角色指定權限

    請求路徑:roles/:roleId/rights/:rightId

    請求方法:delete

    請求參數

    參數名 參數說明 備注

    :roleId 角色ID 不能為空攜帶在url中

    :rightId 權限ID 不能為空攜帶在url中

    響應資料說明

    o傳回目前所有擁有的角色資訊

    響應資料

    {

    “data”: [

    {

    “id”: 101,

    “authName”: “商品管理”,

    “path”: null,

    “children”: [

    {

    “id”: 104,

    “authName”: “商品清單”,

    “path”: null,

    “children”: [

    {

    “id”: 105,

    “authName”: “添加商品”,

    “path”: null

    },

    {

    “id”: 116,

    “authName”: “修改”,

    “path”: null

    }

    ]

    }

    ]

    }

    ],

    “meta”: {

    “msg”: “取消權限成功”,

    “status”: 200

    }

    }

    1.5. 商品分類管理

    1.5.1. 商品資料清單

    請求路徑:categories

    請求方法:get

    請求參數

    參數名 參數說明 備注

    type [1,2,3] 值:1,2,3分别表示顯示一層二層三層分類清單

    響應參數

    參數名 參數說明 備注

    cat_id 分類ID

    cat_name 分類名稱

    cat_pid 分類父ID

    cat_level 分類目前層級

    響應資料

    {

    “data”: [

    {

    “cat_id”: 1,

    “cat_name”: “手機相機”,

    “cat_pid”: 0,

    “cat_level”: 0

    },

    {

    “cat_id”: 2,

    “cat_name”: “電腦辦公”,

    “cat_pid”: 0,

    “cat_level”: 0

    }

    ],

    “meta”: {

    “msg”: “擷取成功”,

    “status”: 200

    }

    }

    1.5.2. 添加分類

    請求路徑:categories

    請求方法:post

    請求參數

    參數名 參數說明 備注

    cat_pid 分類父ID 不能為空

    cat_name 分類名稱 不能為空

    cat_level 分類層級 不能為空

    響應資料

    {

    “data”: {

    “cat_id”: 62,

    “cat_name”: “相框”,

    “cat_pid”: “1”,

    “cat_level”: “1”

    },

    “meta”: {

    “msg”: “建立成功”,

    “status”: 201

    }

    }

    1.5.3. 根據id查詢分類

    請求路徑:categories/:id

    請求方法:get

    請求參數

    參數名 參數說明 備注

    :id 分類ID 不能為空攜帶在url中

    響應資料

    {

    “data”: {

    “cat_id”: 3,

    “cat_name”: “廚衛電器”,

    “cat_pid”: 0,

    “cat_level”: 0

    },

    “meta”: {

    “msg”: “擷取成功”,

    “status”: 200

    }

    }

    1.5.4. 編輯送出分類

    請求路徑:categories/:id

    請求方法:put

    請求參數

    參數名 參數說明 備注

    :id 分類ID 不能為空攜帶在url中

    cat_name 分類名稱 不能為空

    響應資料

    {

    “data”: {

    “cat_id”: 22,

    “cat_name”: “自拍杆”,

    “cat_pid”: 7,

    “cat_level”: 2

    },

    “meta”: {

    “msg”: “更新成功”,

    “status”: 200

    }

    }

    1.5.5. 删除分類

    請求路徑:categories/:id

    請求方法:delete

    請求參數

    參數名 參數說明 備注

    :id 分類ID 不能為空攜帶在url中

    響應資料

    {

    “data”: null,

    “meta”: {

    “msg”: “删除成功”,

    “status”: 200

    }

    }

    1.6. 分類參數管理

    1.6.1. 參數清單

    請求路徑:/:id/attributes

    請求方法:get

    請求參數

    參數名 參數說明 備注

    :id 分類ID 不能為空攜帶在url中

    sel [only,many] 不能為空,通過only或many來擷取分類靜态參數還是動态參數

    響應參數

    參數名 參數說明 備注

    attr_id 分類參數ID

    attr_name 分類參數名稱

    cat_id 分類參數所屬分類

    attr_sel only:輸入框(唯一) many:背景下拉清單/前台單選框

    attr_write manual:手工錄入 list:從清單選擇

    attr_vals 如果attr_write:list,那麼有值,該值以逗号分隔

    響應資料

    {

    “data”: [

    {

    “attr_id”: 1,

    “attr_name”: “cpu”,

    “cat_id”: 22,

    “attr_sel”: “only”,

    “attr_write”: “manual”,

    “attr_vals”: “ffff”

    }

    ],

    “meta”: {

    “msg”: “擷取成功”,

    “status”: 200

    }

    }

    1.6.2. 添加參數

    請求路徑:/:id/attributes

    請求方法:post

    請求參數

    參數名 參數說明 備注

    :id 分類ID 不能為空攜帶在url中

    attr_name 參數名稱 不能為空

    attr_sel [only,many] 不能為空

    attr_vals 如果是many就需要填寫值的選項,以逗号分隔

    響應資料

    {

    “data”: {

    “attr_id”: 44,

    “attr_name”: “測試參數”,

    “cat_id”: “1”,

    “attr_sel”: “many”,

    “attr_write”: “list”,

    “attr_vals”: “a,b,c”

    },

    “meta”: {

    “msg”: “建立成功”,

    “status”: 201

    }

    }

    1.6.3. 删除參數

    請求路徑:/:id/attributes/:attrid

    請求方法:delete

    請求參數

    參數名 參數說明 備注

    :id 分類ID 不能為空攜帶在url中

    :attrid 參數ID 不能為空攜帶在url中

    響應資料

    {

    “data”: null,

    “meta”: {

    “msg”: “删除成功”,

    “status”: 200

    }

    }

    1.6.4. 根據ID查詢參數

    請求路徑:/:id/attributes/:attrId

    請求方法:get

    請求參數

    參數名 參數說明 備注

    :id 分類ID 不能為空攜帶在url中

    :attrId 屬性ID 不能為空攜帶在url中

    attr_sel [only,many] 不能為空

    attr_vals 如果是many就需要填寫值的選項,以逗号分隔

    響應資料

    {

    “data”: {

    “attr_id”: 1,

    “attr_name”: “cpu”,

    “cat_id”: 22,

    “attr_sel”: “only”,

    “attr_write”: “manual”,

    “attr_vals”: “ffff”

    },

    “meta”: {

    “msg”: “擷取成功”,

    “status”: 200

    }

    }

    1.6.5. 編輯送出參數

    請求路徑:/:id/attributes/:attrId

    請求方法:put

    請求參數

    參數名 參數說明 備注

    :id 分類ID 不能為空攜帶在url中

    :attrId 屬性ID 不能為空攜帶在url中

    響應資料

    {

    “data”: {

    “attr_id”: 9,

    “attr_name”: “測試更新”,

    “cat_id”: “43”,

    “attr_sel”: “only”,

    “attr_write”: “manual”,

    “attr_vals”: “abc”

    },

    “meta”: {

    “msg”: “更新成功”,

    “status”: 200

    }

    }

    1.7. 商品管理

    1.7.1. 商品清單資料

    請求路徑:goods

    請求方法:get

    請求參數

    參數名 參數說明 備注

    query 查詢參數 可以為空

    pagenum 目前頁碼 不能為空

    pagesize 每頁顯示條數 不能為空

    響應參數

    參數名 參數說明 備注

    total 總共商品條數

    pagenum 目前商品頁數

    goods_id 商品ID

    goods_name 商品名稱

    goods_price 價格

    goods_number 數量

    goods_weight 重量 不能為空

    goods_state 商品狀态 商品狀态 0: 未通過 1: 稽核中 2: 已稽核

    add_time 添加時間

    upd_time 更新時間

    hot_mumber 熱銷品數量

    is_promote 是否是熱銷品

    響應資料

    {

    “data”: {

    “total”: 50,

    “pagenum”: “1”,

    “goods”: [

    {

    “goods_id”: 144,

    “goods_name”: “asfdsd”,

    “goods_price”: 1,

    “goods_number”: 1,

    “goods_weight”: 1,

    “goods_state”: null,

    “add_time”: 1512954923,

    “upd_time”: 1512954923,

    “hot_mumber”: 0,

    “is_promote”: false

    }

    ]

    },

    “meta”: {

    “msg”: “擷取成功”,

    “status”: 200

    }

    }

    1.7.2. 添加商品

    請求路徑:goods

    請求方法:post

    請求參數

    參數名 參數說明 備注

    goods_name 商品名稱 不能為空

    goods_cat 以為’,‘分割的分類清單 不能為空

    goods_price 價格 不能為空

    goods_number 數量 不能為空

    goods_weight 重量 不能為空

    goods_introduce 介紹 可以為空

    pics 上傳的圖檔臨時路徑(對象) 可以為空

    attrs 商品的參數(數組) 可以為空

    請求資料

    {

    “goods_name”:“test_goods_name2”,

    “goods_price”:20,

    “goods_number”:30,

    “goods_weight”:40,

    “goods_introduce”:“abc”,

    “pics”:[

    {“pic”:"/tmp_uploads/30f08d52c551ecb447277eae232304b8"}

    ],

    “attrs”:[

    {

    “attr_id”:15,

    “attr_value”:“ddd”

    },

    {

    “attr_id”:15,

    “attr_value”:“eee”

    }

    ]

    }

    響應參數

    參數名 參數說明 備注

    total 總共商品條數

    pagenum 目前商品頁數

    goods_id 商品ID

    goods_cat 以為’,'分割的分類清單

    goods_name 商品名稱

    goods_price 價格

    goods_number 數量

    goods_weight 重量 不能為空

    goods_state 商品狀态 商品狀态 0: 未通過 1: 稽核中 2: 已稽核

    add_time 添加時間

    upd_time 更新時間

    hot_mumber 熱銷品數量

    is_promote 是否是熱銷品

    pics 上傳的圖檔臨時路徑(對象) pics_id:圖檔ID,goods_id:商品ID,pics_big:大圖,pics_mid:中圖,pics_sma:小圖

    attrs 商品的參數(數組) goods_id:商品ID,attr_value:目前商品的參數值,add_price:浮動價格,attr_vals:預定義的參數值,attr_sel:手動輸入,還是單選,

    響應資料

    {

    “data”: {

    “goods_id”: 145,

    “goods_name”: “test_goods_name2”,

    “goods_price”: 20,

    “cat_id”: 1,

    “goods_number”: 30,

    “goods_weight”: 40,

    “goods_introduce”: “abc”,

    “goods_big_logo”: “”,

    “goods_small_logo”: “”,

    “goods_state”: 1,

    “add_time”: 1512962370,

    “upd_time”: 1512962370,

    “hot_mumber”: 0,

    “is_promote”: false,

    “pics”: [

    {

    “pics_id”: 397,

    “goods_id”: 145,

    “pics_big”: “uploads/goodspics/big_30f08d52c551ecb447277eae232304b8”,

    “pics_mid”: “uploads/goodspics/mid_30f08d52c551ecb447277eae232304b8”,

    “pics_sma”: “uploads/goodspics/sma_30f08d52c551ecb447277eae232304b8”

    }

    ],

    “attrs”: [

    {

    “goods_id”: 145,

    “attr_id”: 15,

    “attr_value”: “ddd”,

    “add_price”: null,

    “attr_name”: “fffffff”,

    “attr_sel”: “many”,

    “attr_write”: “list”,

    “attr_vals”: “”

    },

    {

    “goods_id”: 145,

    “attr_id”: 15,

    “attr_value”: “eee”,

    “add_price”: null,

    “attr_name”: “fffffff”,

    “attr_sel”: “many”,

    “attr_write”: “list”,

    “attr_vals”: “”

    }

    ]

    },

    “meta”: {

    “msg”: “建立商品成功”,

    “status”: 201

    }

    }

    1.7.3. 根據ID查詢商品

    請求路徑:goods/:id

    請求方法:get

    請求參數

    參數名 參數說明 備注

    id 商品ID 不能為空攜帶在url中

    響應參數

    參數名 參數說明 備注

    total 總共商品條數

    pagenum 目前商品頁數

    goods_id 商品ID

    goods_name 商品名稱

    goods_price 價格

    goods_number 數量

    goods_weight 重量 不能為空

    goods_state 商品狀态 商品狀态 0: 未通過 1: 稽核中 2: 已稽核

    add_time 添加時間

    upd_time 更新時間

    hot_mumber 熱銷品數量

    is_promote 是否是熱銷品

    pics 上傳的圖檔臨時路徑(對象) pics_id:圖檔ID,goods_id:商品ID,pics_big:大圖,pics_mid:中圖,pics_sma:小圖

    attrs 商品的參數(數組) goods_id:商品ID,attr_value:目前商品的參數值,add_price:浮動價格,attr_vals:預定義的參數值,attr_sel:手動輸入,還是單選,

    響應資料

    {

    “data”: {

    “goods_id”: 145,

    “goods_name”: “test_goods_name2”,

    “goods_price”: 20,

    “goods_number”: 30,

    “goods_weight”: 40,

    “goods_introduce”: “abc”,

    “goods_big_logo”: “”,

    “goods_small_logo”: “”,

    “goods_state”: 1,

    “add_time”: 1512962370,

    “upd_time”: 1512962370,

    “hot_mumber”: 0,

    “is_promote”: false,

    “pics”: [

    {

    “pics_id”: 397,

    “goods_id”: 145,

    “pics_big”: “uploads/goodspics/big_30f08d52c551ecb447277eae232304b8”,

    “pics_mid”: “uploads/goodspics/mid_30f08d52c551ecb447277eae232304b8”,

    “pics_sma”: “uploads/goodspics/sma_30f08d52c551ecb447277eae232304b8”

    }

    ],

    “attrs”: [

    {

    “goods_id”: 145,

    “attr_id”: 15,

    “attr_value”: “ddd”,

    “add_price”: null,

    “attr_name”: “fffffff”,

    “attr_sel”: “many”,

    “attr_write”: “list”,

    “attr_vals”: “”

    },

    {

    “goods_id”: 145,

    “attr_id”: 15,

    “attr_value”: “eee”,

    “add_price”: null,

    “attr_name”: “fffffff”,

    “attr_sel”: “many”,

    “attr_write”: “list”,

    “attr_vals”: “”

    }

    ]

    },

    “meta”: {

    “msg”: “建立商品成功”,

    “status”: 201

    }

    }

    1.7.4. 編輯送出商品

    請求路徑:goods/:id

    請求方法:put

    請求參數

    參數名 參數說明 備注

    id 商品ID 不能為空攜帶在url中

    goods_name 商品名稱 不能為空

    goods_price 價格 不能為空

    goods_number 數量 不能為空

    goods_weight 重量 不能為空

    goods_introduce 介紹 可以為空

    pics 上傳的圖檔臨時路徑(對象) 可以為空

    attrs 商品的參數(數組) 可以為空

    請求資料

    {

    “goods_name”:“test_goods_name2”,

    “goods_price”:20,

    “goods_number”:30,

    “goods_weight”:40,

    “goods_introduce”:“abc”,

    “pics”:[

    {“pic”:"/tmp_uploads/30f08d52c551ecb447277eae232304b8"}

    ],

    “attrs”:[

    {

    “attr_id”:15,

    “attr_value”:“ddd”

    },

    {

    “attr_id”:15,

    “attr_value”:“eee”

    }

    ]

    }

    響應參數

    參數名 參數說明 備注

    total 總共商品條數

    pagenum 目前商品頁數

    goods_id 商品ID

    goods_name 商品名稱

    goods_price 價格

    goods_number 數量

    goods_weight 重量 不能為空

    goods_state 商品狀态 商品狀态 0: 未通過 1: 稽核中 2: 已稽核

    add_time 添加時間

    upd_time 更新時間

    hot_mumber 熱銷品數量

    is_promote 是否是熱銷品

    pics 上傳的圖檔臨時路徑(對象) pics_id:圖檔ID,goods_id:商品ID,pics_big:大圖,pics_mid:中圖,pics_sma:小圖

    attrs 商品的參數(數組) goods_id:商品ID,attr_value:目前商品的參數值,add_price:浮動價格,attr_vals:預定義的參數值,attr_sel:手動輸入,還是單選,

    響應資料

    {

    “data”: {

    “goods_id”: 145,

    “goods_name”: “test_goods_name2”,

    “goods_price”: 20,

    “goods_number”: 30,

    “goods_weight”: 40,

    “goods_introduce”: “abc”,

    “goods_big_logo”: “”,

    “goods_small_logo”: “”,

    “goods_state”: 1,

    “add_time”: 1512962370,

    “upd_time”: 1512962370,

    “hot_mumber”: 0,

    “is_promote”: false,

    “pics”: [

    {

    “pics_id”: 397,

    “goods_id”: 145,

    “pics_big”: “uploads/goodspics/big_30f08d52c551ecb447277eae232304b8”,

    “pics_mid”: “uploads/goodspics/mid_30f08d52c551ecb447277eae232304b8”,

    “pics_sma”: “uploads/goodspics/sma_30f08d52c551ecb447277eae232304b8”

    }

    ],

    “attrs”: [

    {

    “goods_id”: 145,

    “attr_id”: 15,

    “attr_value”: “ddd”,

    “add_price”: null,

    “attr_name”: “fffffff”,

    “attr_sel”: “many”,

    “attr_write”: “list”,

    “attr_vals”: “”

    },

    {

    “goods_id”: 145,

    “attr_id”: 15,

    “attr_value”: “eee”,

    “add_price”: null,

    “attr_name”: “fffffff”,

    “attr_sel”: “many”,

    “attr_write”: “list”,

    “attr_vals”: “”

    }

    ]

    },

    “meta”: {

    “msg”: “建立商品成功”,

    “status”: 201

    }

    }

    1.7.5. 删除商品

    請求路徑:goods/:id

    請求方法:delete

    請求參數

    參數名 參數說明 備注

    id 商品ID 不能為空攜帶在url中

    響應資料

    {

    “data”: null,

    “meta”: {

    “msg”: “删除成功”,

    “status”: 200

    }

    }

    ###同步商品圖檔

    請求路徑:goods/:id/pics

    請求方法:put

    請求參數

    參數名 參數說明 備注

    id 商品ID 不能為空攜帶在url中

    pics 商品圖檔集合 如果有pics_id字段會保留該圖檔,如果沒有pics_id但是有pic字段就會新生成圖檔資料

    請求資料

    [

    {“pic”:“tmp_uploads/db28f6316835836e97653b5c75e418be.png”},

    {

    “pics_id”: 397,

    “goods_id”: 145,

    “pics_big”: “uploads/goodspics/big_30f08d52c551ecb447277eae232304b8”,

    “pics_mid”: “uploads/goodspics/mid_30f08d52c551ecb447277eae232304b8”,

    “pics_sma”: “uploads/goodspics/sma_30f08d52c551ecb447277eae232304b8”

    }

    ]

    響應資料

    {

    “data”: {

    “goods_id”: 96,

    “goods_name”: “iphoneXX”,

    “goods_price”: 2,

    “goods_number”: 22,

    “goods_weight”: 22,

    “goods_introduce”: null,

    “goods_big_logo”: “./uploads/goods/20171113/483a3b8e99e534ec3e4312dbbaee7c9d.jpg”,

    “goods_small_logo”: “./uploads/goods/20171113/small_483a3b8e99e534ec3e4312dbbaee7c9d.jpg”,

    “goods_state”: 0,

    “is_del”: “1”,

    “add_time”: 1510045904,

    “upd_time”: 1512635159,

    “delete_time”: 1512635159,

    “hot_mumber”: 0,

    “is_promote”: false,

    “pics”: [

    {

    “pics_id”: 383,

    “goods_id”: 96,

    “pics_big”: “uploads/goodspics/big_6f5750132abd3f5b2b93dd722fcde653.jpg”,

    “pics_mid”: “uploads/goodspics/mid_6f5750132abd3f5b2b93dd722fcde653.jpg”,

    “pics_sma”: “uploads/goodspics/sma_6f5750132abd3f5b2b93dd722fcde653.jpg”

    }

    ],

    “attrs”: [

    {

    “goods_id”: 96,

    “attr_id”: 15,

    “attr_value”: “eee”,

    “add_price”: null,

    “attr_name”: “fffffff”,

    “attr_sel”: “many”,

    “attr_write”: “list”,

    “attr_vals”: “”

    },

    {

    “goods_id”: 96,

    “attr_id”: 15,

    “attr_value”: “ddd”,

    “add_price”: null,

    “attr_name”: “fffffff”,

    “attr_sel”: “many”,

    “attr_write”: “list”,

    “attr_vals”: “”

    }

    ]

    },

    “meta”: {

    “msg”: “更新成功”,

    “status”: 200

    }

    }

    ###同步商品屬性

    請求路徑:goods/:id/attributes

    請求方法:put

    請求參數

    參數名 參數說明 備注

    id 商品ID 不能為空攜帶在url中

    請求資料

    [

    {

    “attr_id”:15,

    “attr_value”:“ddd”

    },

    {

    “attr_id”:15,

    “attr_value”:“eee”

    }

    ]

    響應資料

    {

    “data”: {

    “goods_id”: 96,

    “goods_name”: “iphoneXX”,

    “goods_price”: 2,

    “goods_number”: 22,

    “goods_weight”: 22,

    “goods_introduce”: null,

    “goods_big_logo”: “./uploads/goods/20171113/483a3b8e99e534ec3e4312dbbaee7c9d.jpg”,

    “goods_small_logo”: “./uploads/goods/20171113/small_483a3b8e99e534ec3e4312dbbaee7c9d.jpg”,

    “goods_state”: 0,

    “is_del”: “1”,

    “add_time”: 1510045904,

    “upd_time”: 1512635159,

    “delete_time”: 1512635159,

    “hot_mumber”: 0,

    “is_promote”: false,

    “pics”: [

    {

    “pics_id”: 383,

    “goods_id”: 96,

    “pics_big”: “uploads/goodspics/big_6f5750132abd3f5b2b93dd722fcde653.jpg”,

    “pics_mid”: “uploads/goodspics/mid_6f5750132abd3f5b2b93dd722fcde653.jpg”,

    “pics_sma”: “uploads/goodspics/sma_6f5750132abd3f5b2b93dd722fcde653.jpg”

    }

    ],

    “attrs”: [

    {

    “goods_id”: 96,

    “attr_id”: 15,

    “attr_value”: “eee”,

    “add_price”: null,

    “attr_name”: “fffffff”,

    “attr_sel”: “many”,

    “attr_write”: “list”,

    “attr_vals”: “”

    },

    {

    “goods_id”: 96,

    “attr_id”: 15,

    “attr_value”: “ddd”,

    “add_price”: null,

    “attr_name”: “fffffff”,

    “attr_sel”: “many”,

    “attr_write”: “list”,

    “attr_vals”: “”

    }

    ]

    },

    “meta”: {

    “msg”: “更新成功”,

    “status”: 200

    }

    }

    ###商品圖檔處理必須安裝GraphicsMagick

    linux

    apt-get install GraphicsMagick

    Mac OS X

    brew install GraphicsMagick

    Windows 點選下載下傳

    1.8. 圖檔上傳

    請求路徑:upload

    請求方法:post

    請求參數

    參數名 參數說明 備注

    file 上傳檔案

    響應資料

    {

    “data”: {

    “tmp_path”: “tmp_uploads/ccfc5179a914e94506bcbb7377e8985f.png”,

    “url”: “http://127.0.0.1:8888tmp_uploads/ccfc5179a914e94506bcbb7377e8985f.png”

    },

    “meta”: {

    “msg”: “上傳成功”,

    “status”: 200

    }

    }

    1.9. 訂單管理

    1.9.1. 訂單資料清單

    請求路徑:orders

    請求方法:get

    請求參數

    參數名 參數說明 備注

    query 查詢參數 可以為空

    pagenum 目前頁碼 不能為空

    pagesize 每頁顯示條數 不能為空

    user_id 使用者ID 可以為空

    pay_status 支付狀态 可以為空

    is_send 是否發貨 可以為空

    order_fapiao_title [‘個人’,‘公司’] 可以為空

    order_fapiao_company 公司名稱 可以為空

    order_fapiao_content 發票内容 可以為空

    consignee_addr 發貨位址 可以為空

    響應資料

    {

    “data”: {

    “total”: 1,

    “pagenum”: “1”,

    “goods”: [

    {

    “order_id”: 47,

    “user_id”: 133,

    “order_number”: “itcast-59e7502d7993d”,

    “order_price”: 322,

    “order_pay”: “1”,

    “is_send”: “是”,

    “trade_no”: “”,

    “order_fapiao_title”: “個人”,

    “order_fapiao_company”: “”,

    “order_fapiao_content”: “辦公用品”,

    “consignee_addr”: “a:7:{s:6:“cgn_id”;i:1;s:7:“user_id”;i:133;s:8:“cgn_name”;s:9:“王二柱”;s:11:“cgn_address”;s:51:“北京市海澱區蘇州街長遠天地大廈305室”;s:7:“cgn_tel”;s:11:“13566771298”;s:8:“cgn_code”;s:6:“306810”;s:11:“delete_time”;N;}”,

    “pay_status”: “1”,

    “create_time”: 1508331565,

    “update_time”: 1508331565

    }

    ]

    },

    “meta”: {

    “msg”: “擷取成功”,

    “status”: 200

    }

    }

    1.9.2. 修改訂單狀态

    請求路徑:orders/:id

    請求方法:put

    請求參數

    參數名 參數說明 備注

    id 訂單ID 不能為空攜帶在url中

    is_send 訂單是否發貨 1:已經發貨,0:未發貨

    order_pay 訂單支付 支付方式 0未支付 1支付寶 2微信 3銀行卡

    order_price 訂單價格

    order_number 訂單數量

    pay_status 支付狀态 訂單狀态: 0未付款、1已付款

    請求資料說明

    o所有請求資料都是增量更新,如果參數不填寫,就不會更新該字段

    響應資料

    {

    “data”: {

    “order_id”: 67,

    “user_id”: 1,

    “order_number”: “itcast-g7kmck71vjaujfgoi”,

    “order_price”: 20,

    “order_pay”: “0”,

    “is_send”: “否”,

    “trade_no”: “”,

    “order_fapiao_title”: “個人”,

    “order_fapiao_company”: “”,

    “order_fapiao_content”: “”,

    “consignee_addr”: “”,

    “pay_status”: “0”,

    “create_time”: 1512533560,

    “update_time”: 1512533560,

    “goods”: [

    {

    “id”: 82,

    “order_id”: 67,

    “goods_id”: 96,

    “goods_price”: 333,

    “goods_number”: 2,

    “goods_total_price”: 999

    },

    {

    “id”: 83,

    “order_id”: 67,

    “goods_id”: 95,

    “goods_price”: 666,

    “goods_number”: 5,

    “goods_total_price”: 999

    }

    ]

    },

    “meta”: {

    “msg”: “擷取成功”,

    “status”: 200

    }

    }

    1.9.3. 檢視訂單詳情

    請求路徑:orders/:id

    請求方法:get

    請求參數

    參數名 參數說明 備注

    id 訂單ID 不能為空攜帶在url中

    響應資料

    {

    “data”: {

    “order_id”: 67,

    “user_id”: 1,

    “order_number”: “itcast-g7kmck71vjaujfgoi”,

    “order_price”: 20,

    “order_pay”: “0”,

    “is_send”: “否”,

    “trade_no”: “”,

    “order_fapiao_title”: “個人”,

    “order_fapiao_company”: “”,

    “order_fapiao_content”: “”,

    “consignee_addr”: “”,

    “pay_status”: “0”,

    “create_time”: 1512533560,

    “update_time”: 1512533560,

    “goods”: [

    {

    “id”: 82,

    “order_id”: 67,

    “goods_id”: 96,

    “goods_price”: 333,

    “goods_number”: 2,

    “goods_total_price”: 999

    },

    {

    “id”: 83,

    “order_id”: 67,

    “goods_id”: 95,

    “goods_price”: 666,

    “goods_number”: 5,

    “goods_total_price”: 999

    }

    ]

    },

    “meta”: {

    “msg”: “擷取成功”,

    “status”: 200

    }

    }

    1.10. 資料統計

    1.10.1. 基于類型統計(餅圖)

    請求路徑:reports/:type

    請求方法:get

    響應資料

    1.10.2. 基于時間統計(折線圖)

    請求路徑:reports/:type

    請求方法:get

    響應資料

    1.10.3. 基于銷量統計(柱狀圖)

    請求路徑:reports/:type

    請求方法:get

    響應資料

繼續閱讀