Skip to content

API.md

Latest commit

 

History

History
354 lines (316 loc) · 5.73 KB

API.md

File metadata and controls

354 lines (316 loc) · 5.73 KB

API

要求验证的API需要在header中添加

'authorization': 'Bearer ' + token

可以默认使用

{
    'authorization': 'Bearer ' + token,
    'Content-Type': 'application/x-www-form-urlencoded'
}

作为header。（PUT请求一定要加上'Content-Type'）

auth

POST /api/auth/register

  • Request: 
    {
    'name' : 'name',
    'email' : 'email@email.email',
    'password' : 'password'
}
  • Response: 
    // 注册成功返回201，失败返回400/409
// 理论上是不会返回409的
{
    'message' : 'message',
    'status_code' : 201/400/409,
}

POST /api/auth/login

  • Request: 
    {
    'email' : 'email@email.email',
    'password' : 'password'
}
  • Response: 
    // 登录成功返回200并且返回token，否则返回401且不返回token
{
    'token' : 'token',
    'message' : 'message',
    'status_code' : 200/401
}

GET /api/auth/user (要求验证)

  • Response: 
    {
    'status_code' : 200,
    'data' : {
        'id': id,
        'name': 'name',
        'email': "email@email.email",
        'created_at': "2018-10-21 14:20:04",
        'updated_at': "2018-10-21 14:20:04"
    }
}

GET /api/auth/refresh (要求验证)

  • Response: 
    {
    'status': 'success'
}

GET /api/auth/logout (要求验证)

  • Response: 
    {
    'status_code' : 200,
    'message' : 'Logged out Successfully'
}

User

GET /api/users (要求验证)

  • Response: 
    [
    {
        'status_code' : 200,
        'data' : {
            'id': id,
            'name': 'name',
            'email': "email@email.email",
            'created_at': "2018-10-21 14:20:04",
            'updated_at': "2018-10-21 14:20:04"
        }
    },
    ...
]

GET /api/users/{id}

  • Response: 
    {
    'status_code' : 200,
    'data' : {
        'id': id,
        'name': 'name',
        'email': "email@email.email",
        'created_at': "2018-10-21 14:20:04",
        'updated_at': "2018-10-21 14:20:04"
    }
}
或者
{
    'status_code': 404,
    'message': 'User Not Found'
}

Favorite (要求验证)

GET /api/users/{uid}/favorites

  • Response: 
    [
    {
        'id': 2,
        'name': 'test',
        'lastChapter': 1
    },
    ...
]

以下四个路由验证未通过则返回

{
    'message': '403 Forbidden',
    'status_code': 403
}

GET /api/users/{uid}/favorites/{id}

  • Response: 
    {
    'name': 'test',
    'bid': '12312',
    'lastChapter': 1
}

POST /api/users/{uid}/favorites

  • Request: 
    {
    'name': 'test',
    'bid': '12312',
    'lastChapter': 1
}
  • Response: 
    // 成功返回201，失败返回404
{
    'message' : 'message',
    'status_code' : 201/404
}

PUT /api/users/{uid}/favorites/{id}

  • Resquest: 
    // 一般只传lastChapter
{
    'id': 2,
    'lastChapter': 1,
    'userId': 1,
    'resId': 2
}

DELETE /api/users/{uid}/favorites/{id}

  • Response: 
    {
    'message' : 'message',
    'status_code' : 200
}

Resource

GET /api/resources

  • Response: 
    [
    {
        'id': 2,
        'name': 'test',
        'bid': '12312',
        'lastChapter': 8
    },
    ...
]

GET /api/resources/{id}

  • Response: 
    {
    'id': 2,
    'name': 'test',
    'bid': '12312',
    'lastChapter': 8
}

理论上下面3个api客户端不应该调用

POST /api/resources

  • Request: 
    {
    'name': 'test',
    'bid': '12312',
    'lastChapter': 8
}
  • Response: 
    // 成功返回201，失败返回404
{
    'message' : 'message',
    'status_code' : 201/404
}

PUT /api/resources/{id}

  • Resquest: 
    {
    'id': 2,
    'name': 'test',
    'bid': '12312',
    'lastChapter': 8
}

DELETE /api/resources/{id}

  • Response: 
    {
    'message' : 'message',
    'status_code' : 200
}

SMH

封面图片url: 'https://cf.hamreus.com/cpic/b/' + bid + '.jpg'

GET /api/SMH/search/{name}

  • Response: 
    [
    {
        'name': 'name',
        'bid': 'bid'
    },
    ...
]

GET /api/SMH/books/{bid}

  • Response: 
    {
    'bid': 'bid',
    'name': 'name',
    'dir': [
        {
            'cateName': 'cateName',
            'menuList': [
                {
                    'name': '外传10',
                    'cid': '390614',
                    'page': '21'
                },
                ...
            ]
        },
        ...
    ]
}

GET /api/SMH/books/{bid}/chapters/{cid}

  • Respoense: 
    {
    'path': 'path',
    'file':[
        'filename', 'filename', ...
    ],
    'parm': 'parm'
}
    path + file + parm就是图片地址，需要在header中加上 
    'Referer': 'https://www.manhuagui.com/comic/' + bid + '/' + cid + '.html'

GET /api/SMH/latest

  • Response: 
    [
    {
        'name': 'name',
        'bid': 'bid'
    },
    ...
]

GET /api/SMH/hots

  • Response: 
    [
    {
        'name': 'name',
        'bid': 'bid'
    },
    ...
]