Skip to content

icon

Jump to bottom
Malcolm edited this page Jul 6, 2016 · 10 revisions

图标接口

主要举出获取全部 icon 列表以及图标的增删改查方法。

获取全部已入库图标列表

本接口只能获取已入库的图标，如果需要获取待审核和其他状态的图标需要走审核接口或者获取用户已上传图标接口。本接口供搜索时使用，支持 q=xxx 表示根据 xxx 来模糊查询图标

GET /icons

Response

{
    "ret": true,
    "data":  [
        {
            "id": 3,
            "name": "笔",
            "path": " M829,738 L738,829 L512,603 L286,829 L195,738 L421,512 L195,286 L286,195 L512,421 L738,195 L829,286 L603,512",
            "oldId": null,
            "newId": null
        },
    ]
}

新增图标

接口场景为将 svg 图标置入大库，表示上传图标并等待审核。此接口会将图标信息写入 icon 库，将 icon 的 status 置为 10。其中 icons 参数里需要传递图标名称、标签、图标后缀和图标 path。本次由于图标的名字、后缀都并不确定（可被大库管理员更改），因此并不生成 fontClass 字段，该字段仅存储图标的后缀。

POST /user/icons

Parameters

名称 类型 描述
repoId number 大库id
icons array 图标数组

Input Example

{
    "repoId": 3,
    "icons": [
        {
            "name": "呵呵",
            "tags": "酒杯,酒杯,呵呵",
            "style": "-o",
            "path": " M829,738 L738,829 L512,603 L286,829 L195,738 L421,512 L195,286 L286,195 L512,421 L738,195 L829,286 L603,512"
        }
    ]
}

Response

{
    "ret": true,
    "data": "上传图标成功"
}

获取单个图标信息

图标弹窗使用的接口，可以获取图标的详细情况，包含上传人、所在大库、替换过的图标和被哪个图标替换等各种详细信息。

GET /user/icons/:iconId

Response

{
    "ret": true,
    "data": {
        "id": 3,
        "name": "笔",
        "path": " M829,738 L738,829 L512,603 L286,829 L195,738 L421,512 L195,286 L286,195 L512,421 L738,195 L829,286 L603,512",
        "tags": "你好,呵呵",
        "fontClass": "www-bi-o",
        "code": 61442,
        "oldIcon": {
            "id": 3,
            "name": "笔",
            "path": " M829,738 L738,829 L512,603 L286,829 L195,738 L421,512 L195,286 L286,195 L512,421 L738,195 L829,286 L603,512",
            "tags": "你好,呵呵",
            "fontClass": "www-bi-o",
            "code": 61442,
        },
        "newId": null,
        "repository": {
            "id": 1,
            "name": "无线大客户端",
            "alias": "mobile"
        }
    }
}

根据 icon id 获取 Icon 详细信息

点击小车的时候，根据小车传入的图标数组获取图标的详情。

POST /icons/cart

Parameters

名称 类型 描述
icons array 图标数组

Response

{
  "res": true,
  "data": [
    {
      "id": 1,
      "name": "帮助",
      "path": " M839,726 L770,657 Q857,599 913,511 Q855,419 764,361 Q707,325 643,306.5 Q579,288 512,287 Q461,287 411,298 L333,221 Q418,192 512,192 Q681,194 815,280.5 Q949,367 1023,511 Q990,576 943.5,630.5 Q897,685 839,726 M512,325 Q621,328 693,400 Q765,472 767,581 Q767,615 759,646 L446,334 Q478,325 512,325 M883,883 L883,883 Q896,896 896,915 Q896,934 883,947 Q870,960 851,960 Q832,960 819,947 L677,805 Q599,830 512,830 Q343,828 209,741.5 Q75,655 1,511 Q32,449 76,396.5 Q120,344 175,303 L78,206 Q65,193 64.5,173.5 Q64,154 77,141 Q90,128 109,128 Q128,128 141,141 M111,511 Q169,602 260,661 L272,668 Q257,627 257,581 Q257,539 269.5,501.5 Q282,464 304,432 L244,372 Q164,428 111,511",
      "oldId": null,
      "newId": null
    },
    {
      "id": 3,
      "name": "笔",
      "path": " M829,738 L738,829 L512,603 L286,829 L195,738 L421,512 L195,286 L286,195 L512,421 L738,195 L829,286 L603,512",
      "oldId": null,
      "newId": null
    },
    {
      "id": 4,
      "name": "闭眼",
      "path": " M160,576 Q108,588 124.5,672 Q141,756 192,768 Q169,778 188,848 Q207,918 256,928 Q258,976 296,1000 Q334,1024 384,1024 Q564,1021 607,987 Q650,953 832,928 L832,416 Q644,358 501.5,242 Q359,126 352,0 Q299,-6 260,72 Q221,150 352,384 L160,384 Q91,396 100,480 Q109,564 160,576 M832,960 L960,960 Q987,959 1005,932 Q1023,905 1024,864 L1024,480 Q1023,439 1005,412 Q987,385 960,384 L896,384",
      "oldId": null,
      "newId": null
    }
  ]
}

修改单个图标信息

这一操作依据不同权限进行处理，登录用户只能修改 tags，库管理员可以修改 name。

PATCH /user/icons/:iconId

Parameters

名称 类型 描述
tags string 图标标签
name string 图标名称

Response

{
    "ret": true,
    "data": "修改图标信息成功"
}

删除审核失败的图标

只能删除当前用户上传的，审核失败的图标。

DELETE /user/icons/:iconId

Response

{
    "ret": true,
    "data": "删除图标成功"
}
Clone this wiki locally