Skip to content

repository

Malcolm edited this page Jul 20, 2016 · 2 revisions

大库接口

主要举出大库相关的数据接口,包含获取大库集合、获取单个大库、新建和删除大库、以及更新单个大库的接口。当管理员审核通过图标时会将字体加入大库,会使对单个大库进行更新。

获取全部大库

在获取大库集合时同时返回大库的管理员,在 user 参数里。

GET /repositories 

Response

{
    "ret": true,
    "data": [
        {
            "id": 1,
            "name": "3w",
            "alias": "www",
            "admin": 1,
            "icons": [
                {
                    "id": 1,
                    "name": "h呵呵",
                    "code": 61440
                }
            ],
            "iconCount": 898,
            "user": {
                "id": 1,
                "name": "minghao.yu",
                "actor": 2
            }
        }
    ]
}

创建大库

只有超管才能创建大库。创建时需要用户提供大库名称、别名和所有者,名称和别名均不可重复。

POST /admin/repositories

Parameters

名称 类型 描述
name string 大库名称
alias string 大库别名
admin string 大库所有者的 userId

获取单个大库

使用大库的 id 来获取唯一大库信息。

GET /repositories/:repoId

Response

{
    "ret": true,
    "data": {
        "id": 1,
        "name": "3w",
        "alias": "www",
        "admin": 1,
        "icons": [
            {
                "id": 1,
                "name": "h呵呵",
                "code": 61440
            }
        ],
        "user": {
            "id": 1,
            "name": "minghao.yu",
            "actor": 2
        }
    }
}

更新单个大库

更新大库图标的操作发生在管理员审核图标入库阶段,届时会将管理员输入的图标的 tagsname 作为图标最后确定的值,并给图标生成唯一的 fontClasscode ,并将图标状态更改为 status: 20,此操作详见审核接口。

更新大库基本信息的操作,超管和库管均可进行操作,其中库管仅可操作本库内容,超管可以操作所有库的内容。

超管/库管更新某个大库

PATCH /admin/repositories/:repoId
PATCH /owner/repositories/:repoId

Parameters

名称 类型 描述
notice string 大库消息
admin string 大库所有者的 userId
Clone this wiki locally