目录
一、查询所有已实现接口
基本信息
Path: /mp/
Method: GET
接口描述:
线上接口地址 http://ttapi.research.itcast.cn/mp/
返回已上线接口地址,形如:
{
"user.Authorization": "/v1_0/authorizations",
"user.Captcha": "/v1_0/captchas/<mobile:mobile>",
"user.SMSVerificationCode": "/v1_0/sms/codes/<mobile:mobile>"
}
键为接口名称
值为接口路径
请求参数
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|
二、用户-刷新用户token
基本信息
Path: /mp/v1_0/authorizations
Method: PUT
接口描述:
1. 线上地址 http://ttapi.research.itcast.cn/mp/v1_0/authorizations
2. 返回HTTP状态码
1. 201 OK
2. 400 请求参数错误
3. 403 refresh_token未携带或已过期
4. 507 服务器数据库异常
3. token说明
在Authorization 请求头中携带的token,格式为"Bearer "拼接上token,注意Bearer后有一个空格
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
Authorization | 是 | Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9. eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9. mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU | refresh_token |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
message | string | 必须 | 消息提示 | ||
data | object | 非必须 | 数据 | ||
├─ token | string | 必须 | 用户token令牌 |
三、用户认证(登录)
基本信息
Path: /mp/v1_0/authorizations
Method: POST
接口描述:
1. 线上地址 http://ttapi.research.itcast.cn/app/v1_0/authorizations
2. 返回HTTP状态码
1. 201 OK
2. 400 请求参数错误
包括:参数缺失、手机号格式不正确、验证码失效等
3. 403 用户非实名认证用户,无权限登录
4. 507 服务器数据库异常
3. token说明
token用于访问需要身份认证的普通接口,有效期2小时
refresh_token 用于在token过期后,获取新的用户token,有效期14天
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
mobile | string | 必须 | 手机号 | ||
code | string | 必须 | 验证码 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
message | string | 必须 | 消息提示 | ||
data | object | 非必须 | 数据 | ||
├─ token | string | 必须 | 用户token令牌 | ||
├─ refresh_token | string | 必须 | 用于刷新token的令牌 | ||
├─ id | integer | 必须 | 用户id | ||
├─ name | string | 必须 | 用户昵称 | ||
├─ photo | string | 必须 | 用户头像 |
四、获取人机验证码
基本信息
Path: /mp/v1_0/captchas/:mobile
Method: GET
接口描述:
1 线上接口路径 http://ttapi.research.itcast.cn/mp/v1_0/captchas/:mobile
2 返回HTTP状态码
- 200 OK
- 404 手机号不正确
- 507 服务器数据库异常
- 429 接口访问次数受限
3 接口访问次数受限
每个手机号每分钟1次,若1分钟频繁发送会提示
4 返回值
{
"message": "OK",
"data": {
"success": 1,
"gt": "f00de9ed073bd781c94509932a309159",
"challenge": "e902f4f9b8b4e63dda3db1ae12ad018c",
"new_captcha": true
}
}
请求参数
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
mobile | 手机号 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
message | string | 必须 | 消息提示 | ||
data | object | 必须 | |||
├─ success | integer | 必须 | GeeTest返回值 | ||
├─ gt | string | 必须 | GeeTest返回值 | ||
├─ challenge | string | 必须 | GeeTest返回值 | ||
├─ new_captcha | boolean | 必须 | GeeTest返回值 |
五、获取用户自己信息
基本信息
Path: /app/v1_0/user
Method: GET
接口描述:
1 线上接口路径 http://ttapi.research.itcast.cn/app/v1_0/user
2 返回HTTP状态码
1. 201 OK
2. 401 token过期或未传
3. 507 服务器数据库异常
3 token说明
在Authorization 请求头中携带的token,格式为"Bearer "拼接上token,注意Bearer后有一个空格
请求参数
Headers
这个接口中需要给头部Authorization提供token值,后面就不需要提供该参数,直接将token值统一配置到axios拦截器中
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
Authorization | 是 | Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9. eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9. mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU | refresh_token |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | |
---|---|---|---|---|---|---|
message | string | 必须 | 消息提示 | |||
data | object | 必须 | 数据 | |||
├─ id | integer | 必须 | 用户id | |||
├─ name | string | 必须 | 用户名 | |||
├─ intro | string | 必须 | 头条号简介 | |||
├─ photo | string | 必须 | 用户头像 | |||
string | 必须 | 邮箱 | ||||
├─ mobile | string | 必须 | 手机号 |
六、获取文章频道(首页频道列表,我的频道)
基本信息
Path: /app/v1_0/user/channels
Method: GET
接口描述:
1 线上接口路径 http://ttapi.research.itcast.cn/app/v1_0/user/channels
2 返回HTTP状态码
1. 201 OK
2. 507 服务器数据库异常
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | |
---|---|---|---|---|---|---|
message | string | 必须 | 消息提示 | |||
data | object | 非必须 | 数据 | |||
├─ id | integer | 必须 | 频道id | |||
├─ name | string | 必须 | 频道名称 | |||
├─ channels | object [] | 非必须 | 频道 | item 类型: object | ||
├─ mobile | string | 必须 | 手机号 |
七、获取文章列表
基本信息
Path: /app/v1_1/articles
Method: GET
接口描述:
1 线上接口路径 http://ttapi.research.itcast.cn/app/v1_1/articles
2 返回HTTP状态码
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
channel_id | 是 | 频道id,不传为全部 | |
timestamp | 是 | 1630479008523 | 时间戳 |
with_top | 是 | 0或1 | 是否包含置顶 |
返回数据
见接口返回的:http://ttapi.research.itcast.cn/app/v1_1/articles?channel_id=0×tamp=1630479008623&with_top=1
八、获取所有频道列表
基本信息
Path: /app/v1_0/channels
Method: GET
接口描述:
1 线上接口路径 http://ttapi.research.itcast.cn/app/v1_0/channels
2 返回HTTP状态码
1. 200 OK
2. 507 服务器数据库异常
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | |
---|---|---|---|---|---|---|
message | string | 必须 | 消息提示 | |||
data | object | 非必须 | 数据 | |||
├─ channels | object [] | 非必须 | 频道 | item 类型: object | ||
├─ id | integer | 必须 | 频道id | |||
├─ name | string | 必须 | 频道名称 |
九、获取文章搜索结果
基本信息
Path: /app/v1_0/search
Method: GET
接口描述:
1 线上接口路径 http://ttapi.research.itcast.cn/app/v1_0/search
2 返回HTTP状态码
1. 200 OK
2. 400 请求参数错误
3. 401 token过期或未传~~~~
4. 507 服务器数据库异常
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
q | 是 | 检索关键词 | |
page | 否 | 页数 | |
per_page | 否 | 每页数量 |