-
服务器请求地址：http://ts.lagou.uieee.com
客户端访问统一接口规则 ：
gitHub 完整 API 接口服务文档查阅：https://github.com/slimkit/slimkit.github.io/tree/gh-pages/docs
-
体验版前台地址：http://ts.lagou.uieee.com/feeds
-
后台管理系统地址： http://ts.lagou.uieee.com/admin
体验账号：root
登陆密码：root
1.1 查询所有广告位
1.2 获取一个广告位的广告列表
1.3 批量获取广告列表
| 名称 | 类型 | 描述 |
|---|
| space | 字符串 | 广告位id，多个以逗号隔开 |
2.1 批量获取动态列表信息
| 名称 | 类型 | 描述 |
|---|
| limit | Integer | 可选，默认值 20 ，获取条数 |
| after | Integer | 可选，上次获取到数据最后一条 ID，用于获取该 ID 之后的数据。 |
| type | String | 可选，默认值 new，可选值 、 、 、 |
| search | String | type = 时可选，搜索关键字 |
| user | Integer | type = 时可选，默认值为当前用户id |
| screen | string | type = 时可选，-付费动态 - 置顶动态 |
| or | 可选，按照动态 ID 获取动态列表。 |
| | 可选，仅 时有效，用于热门数据翻页标记！上次获取数据最后一条的 值 |
| 名称 | 类型 | 描述 |
|---|
| id | int | 动态数据id |
| user_id | int | 发布者id |
| feed_content | string | 动态内容 |
| feed_from | int | 动态来源 1:pc 2:h5 3:ios 4:android 5:其他 |
| like_count | int | 点赞数 |
| feed_view_count | int | 查看数 |
| feed_comment_count | int | 评论数 |
| feed_latitude | string | 纬度 |
| feed_longtitude | string | 经度 |
| feed_geohash | string | GEO |
| audit_status | int | 审核状态 |
| feed_mark | int | 标记 |
| pinned | int | 置顶标记 |
| pinned_amount | int | 置顶金额 |
| comments | array | 动态评论 列表中返回五条 |
| comments.id | int | 评论id |
| comments.user_id | int | 评论者id |
| comments.target_user | int | 资源作者id |
| comments.reply_user | int | 被回复者id |
| comments.body | string | 评论内容 |
| comments.pinned | bool | 评论置顶标记 不存在则为普通评论 |
| has_collect | bool | 是否已收藏 |
| has_like | bool | 是否已赞 |
| images | array | 图片信息 同单条动态数据结构一致 |
| paid_node | array | 付费节点信息 同单条动态数据结构一致 不存在时为null |
| | 参考「动态详情」，内容一致。 |
2.2 获取指定 ID 动态详情
2.3 创建一条动态
| Name | Type | Description |
|---|
| feed_content | string | 分享内容。如果存在附件，则为可选，否则必须存在 |
| feed_from | integer | 客户端标识，1-PC、2-Wap、3-iOS、4-android、5-其他 |
| feed_mark | mixed | 客户端请求唯一标识 |
| feed_latitude | string | 纬度，当经度， GeoHash 任意一个存在，则本字段必须存在 |
| feed_longtitude | string | 经度，当纬度， GeoHash 任意一个存在，则本字段必须存在 |
| feed_geohash | string | GeoHash，当纬度、经度 任意一个存在，则本字段必须存在 |
| amount | inteter | 动态收费，不存在表示不收费，存在表示收费。 |
| images | array | 结构：，amount 为可选，id 必须存在，amount 为收费金额，单位分, type 为收费方式 |
| | 可选，需要关联的话题 ID 数组。 |
| | 如果 存在则必须，话题 ID。 |
| | 可选，如果 存在则必须，转发资源类型标识。 |
| | 可选，如果 存在则必须，转发资源 ID。 |
2.4 点赞、取消点赞、点赞列表 当前动态
点赞
取消点赞
点赞人列表
| 名称 | 类型 | 描述 |
|---|
| limit | Integer | 获取条数，默认 20 |
| after | Integer | 获取之后数据，默认 0 |
| 字段 | 描述 |
|---|
| id | 喜欢 ID |
| user_id | 点喜欢用户 ID |
| target_user | 接收喜欢用户 ID |
| likeable_id | 喜欢的资源 ID，配置 表示不同资源 |
| likeable_type | 喜欢的资源类型。 |
| created_at | 点喜欢时间 |
| updated_at | 更新时间 |
| user | 点喜欢的用户资料，结构参考 「用户信息」接口说明。 |
2.5 评论指定 ID 动态
发布一条评论
| Name | Type | Description |
|---|
| body | String | 评论内容 |
| reply_user | Integer | 评论用户 ID |
获取当前动态所有评论
| Name | Type | Description |
|---|
| limit | Integer | 单次请求条数，默认为20 |
| after | Integer | 最后一条评论的 ID 用来做请求区分 |
| Name | Description |
|---|
| pinneds | Pinned comments list. |
| comment | Comments list. |
| *.id | The of the comment. |
| *.user_id | Commentator. |
| *.target_user | Own dynamic publisher. |
| *.reply_user | Reverted to the user. |
| *.body | The of the comment. |
| *.commentable_id | Feeds id. |
| *.commentable_type | Commentable type. |
| *.created_at | Comment release time. |
| *.updated_at | Comment update time. |
获取当前一条评论的详细信息
| Name | Description |
|---|
| id | The of the comment. |
| user_id | Commentator. |
| target_user | Own dynamic publisher. |
| reply_user | Reverted to the user. |
| body | The of the comment. |
| commentable_id | Feeds id. |
| commentable_type | Commentable type. |
| created_at | Comment release time. |
| updated_at | Comment update time. |
删除一条评论
2.6 删除指定 ID动态
2.7 收藏、取消收藏当前动态
收藏
取消收藏
收藏列表
| 名称 | 类型 | 描述 |
|---|
| limit | Integer | 可选，默认值 20 ，获取条数 |
| offset | Integer | 可选，偏移量，用于翻页，传入已请求过的数据总数 |
| user | Integer | type = 时可选，默认值为当前用户id |
2.8 举报一个动态
| 名称 | 描述 |
|---|
| reason | 举报理由 |
3.1 批量获取资讯列表信息
| 名称 | 说明 |
|---|
| limit | 数据返回条数 默认为20 |
| after | 数据翻页标识 |
| key | 搜索关键字 |
| cate_id | 分类id |
| recommend | 推荐筛选 =1为筛选推荐资讯列表 |
| 需要按照 ID 获取的资讯 ID，多个使用半角 进行分割 |
| 名称 | 类型 | 说明 |
|---|
| id | int | 数据id |
| title | string | 资讯标题 |
| subject | string | 副标题 |
| from | string | 来源 |
| author | string | 作者 |
| user_id | int | 发布者id |
| hits | int | 点击数 |
| has_collect | bool | 当前用户是否已收藏 |
| has_like | bool | 当前用户是否已点赞 |
| category | array | 所属分类信息 |
| category.id | int | 所属分类id |
| category.name | string | 所属分类名称 |
| category.rank | int | 所属分类排序 |
| image | array/null | 资讯封面信息 为null时表示该资讯无缩略图 |
| image.id | int | 资讯封面附件id |
| image.size | string | 资讯封面尺寸 |
3.2 获取指定 ID 资讯详情信息
| 名称 | 类型 | 说明 |
|---|
| id | int | 资讯id |
| title | string | 标题 |
| content | text | 资讯内容 markdown格式 含自定义标签() |
| digg_count | int | 点赞数 |
| comment_count | int | 评论数 |
| hits | int | 点击量 |
| from | string | 来源 |
| is_recommend | int | 是否为推荐 |
| subject | string | 副标题 |
| author | string | 作者 |
| audit_status | int | 审核状态 0-正常 1-待审核 2-草稿 3-驳回 4-删除 5-退款中 |
| audit_count | int | 审核驳回次数 |
| user_id | int | 发布者id |
| contribute_amount | int | 投稿金额 |
| has_collect | bool | 当前用户是否已收藏 |
| has_like | bool | 当前用户是否已点赞 |
| is_pinned | bool | 是否已置顶 1-已置顶 |
| category | array | 所属分类信息 |
| category.id | int | 所属分类id |
| category.name | string | 所属分类名称 |
| category.rank | int | 所属分类排序 |
| image | array | 资讯封面信息 |
| image.id | int | 资讯封面附件id |
| image.size | string | 资讯封面尺寸 |
| tags | array | 标签列表 |
| tags.id | int | 标签id |
| tags.name | string | 标签名称 |
| tags.tag_category_id | int | 标签分类id |
3.3 点赞、取消点赞、点赞列表当前资讯
喜欢资讯
取消喜欢资讯
资讯喜欢列表
| 名称 | 类型 | 说明 |
|---|
| user_id | int | 喜欢用户id |
| target_user | int | 被喜欢用户id |
| likeable_id | int | 被喜欢资源id |
| created_at | date | 喜欢时间 |
| user | array | 用户信息 |
3.4 评论指定 ID 资讯
评论一条资讯
| 名称 | 描述 |
|---|
| body | 评论内容 |
| reply_user | 被回复用户id 默认为0 |
| 名称 | 描述 |
|---|
| message | 消息 |
| comment | 评论信息 |
| comment.id | 评论id |
| comment.user_id | 评论者id |
| comment.target_user | 资讯发布者id |
| comment.reply_user | 被回复者id |
| comment.body | 评论内容 |
获取一条资讯的评论列表
| 名称 | 类型 | 必须 | 说明 |
|---|
| limit | int | - | 数据返回条数 |
| after | int | - | 数据翻页标识 |
| 名称 | 描述 |
|---|
| pinneds | 置顶评论 |
| comments | 评论列表 |
| id | 评论id |
| user_id | 评论者id |
| target_user | 资讯发布者id |
| reply_user | 被回复者id |
| body | 评论内容 |
删除一条资讯评论
3.5 收藏、取消收藏资讯信息
收藏资讯
取消收藏资讯
获取收藏资讯
| 名称 | 类型 | 必填 | 说明 |
|---|
| limit | int | - | 数据返回条数 |
| after | int | - | 数据翻页标识 |
| 名称 | 类型 | 说明 |
|---|
| id | int | 数据id |
| title | string | 资讯标题 |
| subject | string | 副标题 |
| from | string | 来源 |
| author | string | 作者 |
| user_id | int | 发布者id |
| hits | int | 点击数 |
| has_collect | bool | 当前用户是否已收藏 |
| has_like | bool | 当前用户是否已点赞 |
| category | array | 所属分类信息 |
| category.id | int | 所属分类id |
| category.name | string | 所属分类名称 |
| category.rank | int | 所属分类排序 |
| image | array | 资讯封面信息 |
| image.id | int | 资讯封面附件id |
| image.size | string | 资讯封面尺寸 |
3.6 举报一个资讯
| 名称 | 描述 |
|---|
| reason | 举报理由 |
4.1 用户注册 - 图形验证码
PS: 使用该图形验证码的目的是为了防止 短信、邮件 恶意注册
在这里验证码验证的过程掌握逻辑即可
4.2 用户注册 - 获取验证码
PS：使用验证码的目的是为了确保用户注册电话或者邮箱的唯一性，防止用户恶意注册
发送验证码支持 和
非注册用户发送：
注册用户发送：
| 名称 | 类型 | 描述 |
|---|
| phone | String | 如果 不存在则必须，以 模式给手机发送验证码。 |
| email | String | 如果 不存在则必须，以 模式给邮箱发送验证码。 |
4.3 用户注册 - 提交注册信息
| 名称 | 类型 | 描述 |
|---|
| name | 字符串 | 必须，用户名 |
| phone | 字符串 | 如果 为 则必须, 手机号码。 |
| email | String | 如果 为 则必须, E-Mail。 |
| password | String | 可选，密码，如果不输入密码，允许用户无密码注册。 |
| verifiable_type | 枚举: 或 | 必须，验证码发送模式。 |
| verifiable_code | 字符串或数字 | 必须，用户收到的验证码。(教学阶段验证码统一使用 8888 ) |
4.4 用户登陆
| 名称 | 类型 | 描述 |
|---|
| login | 字符串 | 必须，用户认证字段，可以是 、 和 。 |
| password | 字符串 | 可选，用户密码。 |
| | 可选，登录验证码。 |
或者 必须选择一个，如果选择 进行登录。那么 字段只能是 或者 。
| 字段 | 描述 |
|---|
| access_token | 授权 Token |
| token_type | Token 类型 |
| expires_in | 过期时间，单位分 |
| refresh_ttl | 刷新过期时间，单位分 |
4.5 用户退出
需要
4.6 刷新当前用户 Token
需要
4.7 获取当前登录用户未读消息
Unread message count（未读消息统计）
At me（@我的）
| Name | Type | Description |
|---|
| | 可选，请求的数据条数，默认 ，允许范围 。 |
| | 可选，数据开始查找的位置标记，默认 ，来源响应体的 字段。 |
| | 可选，以 标记开始的数据顺序，默认 ，允许值：/。 |
4.8 获取当前登陆用户签到相关信息
获取签到信息
| 字段 | 描述 |
|---|
| rank_users | 当日前五签到用户，按照签到时间顺序排列。（参考「用户资料」接口文档） |
| checked_in | 当前用户是否已签到。 |
| checkin_count | 当前用户签到总天数。 |
| last_checkin_count | 当前用户连续签到天数。 |
| attach_balance | 签到用户积分增加值，单位是真实货币「分」单位。 |
签到
累计签到排行榜
| 名称 | 类型 | 描述 |
|---|
| offset | Integer | 数据偏移数，默认为 。 |
| limit | Integer | 查询数据条数 |
4.9 获取一个用户
- 获取指定用户：
| 变量 | 描述 | | | 这个变量可以是「用户名」、「邮箱」、「手机号码」和「用户ID」 |
| 参数 | 类型 | 描述 |
|---|
| following | Integer | 检查请求用户是否关注了指定的用户，传递要检查的用户 ID，默认为当前登录用户。 |
| follower | Integer | 检查请求用户是否被某个用户关注，传递要检查的用户 ID，默认为当前登录用户。 |
- 获取当前认证用户
4.10 更新认证用户资料
| 字段 | 类型 | 描述 |
|---|
| name | 字符串 | 用户新的用户名。 |
| bio | 字符串 | 用户新的个人传记。 |
| sex | 数字 | 用户新的性别。 |
| location | 字符串 | 用户新的位置信息。 |
| | 可选，用户头像的 File node 值 |
| | 可选，用户背景图片的 File node 值 |
- 更新认证用户的手机号码和邮箱
| 字段 | 类型 | 描述 |
|---|
| phone | 字符串 | 如果 不存在则必须，用户新的手机号码。 |
| email | 字符串 | 如果 不存在则必须，用户新的邮箱地址。 |
| verifiable_code | 字符串或者数字 | 必须，验证码。 |
- 更新认证用户密码
| 名称 | 类型 | 描述 |
|---|
| old_password | 字符串 | 用户已设置密码时必须，用户密码。 |
| password | 字符串 | 必须，用户的新密码 |
| password_/confirm/iation | 字符串 | 必须，用户的新密码，必须和 一致。 |
4.11 获取所有用户
| 名称 | 类型 | 描述 |
|---|
| | 可选，请求获取的数据量，默认为 条，最低获取 条，最多获取 条。 |
| | 可选，排序方式，默认 ，可选 或 。 |
| | 可选，上次请求的最后一条的 ，用于获取这个用户之后的数据。 |
| | 可选用于检索包含 传递字符串用户名的用户；如果 是 那么这里就是完整的用户名，多个用户名使用 进行分割。 |
| | 可选，获取数据的方式，默认是 已常规方式进行获取，允许值： 使用 字段进行按照用户名获取、 使用 字段按照用户 ID 进行获取。 |
| or | 可选，获取一个或者多个指定的用户，如果获取多个请使用 将用户 ID进行字符串拼接。 |
4.12 用户找回密码
| 名称 | 类型 | 描述 |
|---|
| verifiable_type | 枚举： 或者 | 必须，验证码发送模式。 |
| verifiable_code | 字符串或者整数 | 必须，用户收到的验证码。 |
| email | 字符串 | 如果 值为 ，那么这个字段为必须，用户邮箱。 |
| phone | 字符串 | 如果 值为 。那么这个字段为必须，用户手机号码。 |
| password | 字符串 | 用户新密码。 |
4.13 解除用户 Phone 或者 E-Mail 绑定
解除用户 Phone 绑定:
解除用户 E-Mail 绑定:
| 名称 | 类型 | 描述 |
|---|
| password | String | 用户密码。 |
| verifiable_code | Int 或者 String | 手机号码或者邮箱验证码。 |
5.1 获取文件 hash 信息
PS：通过 微信 API 文件读取接口读取文件
5.2 文件上传检查
PS：依赖上一步获取到的 值
5.3 文件上传
| 名称 | 类型 | 描述 |
|---|
| file | File | 待上传的文件 |
5.4 文件获取
