users （用戶）
- Get an user information（需驗(yàn)證）
GET /users/:uid/info
volumes （譜冊(cè)）
- List volumes
GET /volumes
Response
{
{
"vid": 1,
"name": "2018年01月新番精選",
"cover": "https://user-images.githubusercontent.com/35213527/35343025-8dbb8604-0164-11e8-9ee9-107ed45359c7.png",
"describe": "I'm having a problem with this.",
"uid": 1,
"label":[
"新番",
"老番"
],
"status":0,
"create_date":@date
},
{
"vid": 1,
"name": "2018年01月新番精選",
"cover": "https://user-images.githubusercontent.com/35213527/35343025-8dbb8604-0164-11e8-9ee9-107ed45359c7.png",
"describe": "I'm having a problem with this.",
"uid": 1,
"label":[
"新番",
"老番"
],
"status":0,
"create_date":@date
},
{
"vid": 1,
"name": "2018年01月新番精選",
"cover": "https://user-images.githubusercontent.com/35213527/35343025-8dbb8604-0164-11e8-9ee9-107ed45359c7.png",
"describe": "I'm having a problem with this.",
"uid": 1,
"label":[
"新番",
"老番"
],
"status":0,
"create_date":@date
}
}
List volumes created by a user
GET /users/:uid/volumesGet a single volume
GET /volumes/:vidCreate a volume
POST /volumes
Example
{
"name": "2018年01月新番精選",
"uid": 1
}
Response
Status: 201 Created
Location: https://api.bipubipu.com/volumes/:vid
{
"vid": 1,
"name": "2018年01月新番精選",
"cover": "template_url",
"describe": "none",
"uid": 1,
"label":[ ],
"status":1,
"create_date":@date
}
- Edit a volume （需驗(yàn)證）
PATCH /volumes/:vid
Example
{
"name": "2018年01月新番精選",
"cover": "https://user-images.githubusercontent.com/35213527/35343025-8dbb8604-0164-11e8-9ee9-107ed45359c7.png",
"describe": "I'm having a problem with this.",
"label":[
"新番",
"老番"
],
"status":0
}
Response
Status: 200 OK
{
"vid": 1,
"name": "2018年01月新番精選",
"cover": "https://user-images.githubusercontent.com/35213527/35343025-8dbb8604-0164-11e8-9ee9-107ed45359c7.png",
"describe": "I'm having a problem with this.",
"uid": 1,
"label":[
"新番",
"老番"
],
"status":0,
"create_date":@date
}
- Delete a volume （需驗(yàn)證）
DELETE /volumes/:vid
Response
Status: 204 No Content
List scores in a volume
GET /volumes/:vid/scoresAdd a score to a volume （需驗(yàn)證）
POST /volumes/:vid/scoresDelete a score from a volume （需驗(yàn)證）
DELETE /volumes/:vid/scores/:sid
favorite （收藏夾）
List scores in a favorite
GET /users/:uid/favoriteAdd a score to a favorite （需驗(yàn)證）
POST /users/:uid/favorite/scoresDelete a score from a favorite （需驗(yàn)證）
DELETE /users/:uid/favorite/scores/:sidSetting the status of a favorite（需驗(yàn)證）
PATCH /users/:uid/favorite
collection（譜冊(cè)收藏夾）
List volumes in a collection
GET /users/:uid/collectionAdd a volume to a collection （需驗(yàn)證）
POST /users/:uid/collection/scoresDelete a volume from a collection （需驗(yàn)證）
DELETE /users/:uid/collection/scores/:sidSetting the status of a collection（需驗(yàn)證）
PATCH /users/:uid/collection
search （搜索）
- Search volumes
GET /search/volumes
舉例：列出所有含有新番標(biāo)簽佛析，狀態(tài)公開儒鹿，按創(chuàng)建日期降序排列的譜冊(cè)
GET /search/volumes?label=新番&status=1&sort=created&order=desc
舉例：列出所有狀態(tài)公開脚草，按被收藏?cái)?shù)量降序排列的譜冊(cè)
GET /search/volumes?status=1&sort=hot&order=desc
| Name | Type | Description |
|---|---|---|
| label | string |
Filter volumes based on their labels. |
| status | TINYINT(4) |
Filter volumes based on their status. deleted:0,public:1,private:2,reviewed:3.Default: 1. |
| sort | string |
The sort field. Can be hot, created. Default: results are sorted by hot. |
| order | string |
The sort order if sort parameter is provided. One of asc or desc. Default: desc
|
