[关闭]
@cfygaoyang 2018-02-24T06:08:30.000000Z 字数 8918 阅读 420

圈子接口文档（APP）

未分类

获取token

POST /api/access_token

参数 类型 必须 说明
phone 字符串 是 手机号
password 字符串 是 密码

或

参数 类型 必须 说明
phone 字符串 是 手机号
code 字符串 是 验证码 
  1. {
  2.     "code": 0,
  3.     "status": "success",
  4.     "message": {
  5.         "access_token": "884ffcc9d7af0b9a9abb2d1696a4a9db0a80b2bba2dc79fa4b05d10ebdd9",
  6.         "expires_in": 604800,
  7.         "expires_at": "2018-02-05 15:14:23",
  8.         "refresh_token": "f28f213ca3e202c4feca66b1eec863c68adf7aa570e4a6cf4d270382bf95"
  9.     }
  10. }

刷新token

POST /api/refresh_token

参数 类型 必须 说明
refresh_token 字符串 是 刷新Token 
  1. {
  2.     "code": 0,
  3.     "status": "success",
  4.     "message": ""
  5. }

销毁token

POST /api/destroy_token

参数 类型 必须 说明
refresh_token 字符串 是 刷新Token 
  1. {
  2.     "code": 0,
  3.     "status": "success",
  4.     "message": ""
  5. }

发送验证码

POST /api/send_code

参数 类型 必须 说明
phone 字符串 是 密码 
  1. {
  2.     "code": 0,
  3.     "status": "success",
  4.     "message": ""
  5. }

设置密码

POST /api/reset_password

  1. {
  2.     "Authorization": " Token c8b1243cc508efc1e0d07e7a4091cee566d9976320edab08ea86886eeb27"
  3. }
参数 类型 必须 说明
password 字符串 是 密码 
  1. {
  2.     "code": 0,
  3.     "status": "success",
  4.     "message": ""
  5. }

获取用户信息

GET /api/user/info

  1. {
  2.     "Authorization": " Token c8b1243cc508efc1e0d07e7a4091cee566d9976320edab08ea86886eeb27"
  3. }
  1. {
  2.     "code": 0,
  3.     "status": "success",
  4.     "message": {
  5.         "id": 1,
  6.         "access_key": 0,
  7.         "created_at": "2018-01-08 15:55:03",
  8.         "updated_at": "2018-01-08 15:55:03",
  9.         "avatar": "",
  10.         "birthday": "",
  11.         "sex": 2,
  12.         "city": "",
  13.         "address": "",
  14.         "user": 1,
  15.         "username": "18888888889",
  16.         "phone": "18888888889",
  17.         "email": ""
  18.     }
  19. }

编辑用户信息

PUT /api/user/info

  1. {
  2.     "Authorization": " Token c8b1243cc508efc1e0d07e7a4091cee566d9976320edab08ea86886eeb27"
  3. }
参数 类型 必须 说明
avatar 字符串 可选 头像
birthday 字符串 可选 生日
sex 整型 可选 性别 （0：女 1：男 2：保密）
city 字符串 可选 城市
address 字符串 可选 住址
username 字符串 可选 昵称
phone 字符串 可选 手机
email 字符串 可选 邮箱 
  1. {
  2.     "code": 0,
  3.     "status": "success",
  4.     "message": {
  5.         "id": 1,
  6.         "access_key": 0,
  7.         "created_at": "2018-01-08 15:55:03",
  8.         "updated_at": "2018-01-08 15:55:03",
  9.         "avatar": "",
  10.         "birthday": "",
  11.         "sex": 2,
  12.         "city": "",
  13.         "address": "",
  14.         "user": 1,
  15.         "username": "18888888889",
  16.         "phone": "18888888889",
  17.         "email": ""
  18.     }
  19. }

获取话题列表

GET /api/topic

  1. {
  2.     "code": 0,
  3.     "status": "success",
  4.     "message": {
  5.         "total": 1,
  6.         "pages": 1,
  7.         "current_page": 1,
  8.         "page_size": 20,
  9.         "data": [
  10.             {
  11.                 "id": 2,
  12.                 "created_at": "2018-01-18 17:24:38",
  13.                 "updated_at": "2018-01-18 17:24:38",
  14.                 "topic_name": "人工智能",
  15.                 "topic_description": "",
  16.                 "topic_thumbnail": ""
  17.             }
  18.         ]
  19.     }
  20. }

获取话题详情

GET /api/topic/{pk}

参数 类型 必须 说明
pk 整型 是 话题主键ID(url) 
  1. {
  2.     "code": 0,
  3.     "status": "success",
  4.     "message": {
  5.         "id": 2,
  6.         "created_at": "2018-01-18 17:24:38",
  7.         "updated_at": "2018-01-18 17:24:38",
  8.         "topic_name": "人工智能",
  9.         "topic_description": "",
  10.         "topic_thumbnail": ""
  11.     }
  12. }

发布帖子

POST /api/card

参数 类型 必须 说明
card_title 字符串 是 标题
card_content 字符串 是 内容
topic 整型 是 所属话题 
  1. {
  2.     "Authorization": " Token c8b1243cc508efc1e0d07e7a4091cee566d9976320edab08ea86886eeb27"
  3. }
  1. {
  2.     "code": 0,
  3.     "status": "success",
  4.     "message": {
  5.         "id": 1,
  6.         "created_at": "2018-01-23 10:35:15",
  7.         "updated_at": "2018-01-23 10:35:15",
  8.         "card_title": "标题",
  9.         "card_content": "内容",
  10.         "see_num": 0,
  11.         "topic": 2,
  12.         "user": 1
  13.     }
  14. }

获取帖子列表

GET /api/card

参数 类型 必须 说明
topic 整型 可选 主题ID,根据主题筛选帖子列表
user 整型 可选 发帖人ID,根据用户筛选帖子列表 
  1. {
  2.     "code": 0,
  3.     "status": "success",
  4.     "message": {
  5.         "total": 1,
  6.         "pages": 1,
  7.         "current_page": 1,
  8.         "page_size": 20,
  9.         "data": [
  10.             {
  11.                 "id": 3,
  12.                 "created_at": "2018-01-29T15:15:48.004617",
  13.                 "updated_at": "2018-01-29T15:15:48.004617",
  14.                 "card_title": "标题",
  15.                 "card_content": "内容",
  16.                 "see_num": 0,
  17.                 "topic_id": 2,
  18.                 "user_id": 1,
  19.                 "avatar": "",
  20.                 "username": "18656660930",
  21.                 "comment_num": 1,
  22.                 "collection_num": 0,
  23.                 "liked_num": 1
  24.             }
  25.         ]
  26.     }
  27. }

获取帖子详情

GET /api/card/{pk}

参数 类型 必须 说明
pk 整型 是 帖子主键ID(url) 
  1. {
  2.     "code": 0,
  3.     "status": "success",
  4.     "message": {
  5.         "id": 3,
  6.         "created_at": "2018-01-29T15:15:48.004617",
  7.         "updated_at": "2018-01-29T15:15:48.004617",
  8.         "card_title": "标题",
  9.         "card_content": "内容",
  10.         "see_num": 0,
  11.         "topic_id": 2,
  12.         "user_id": 1,
  13.         "avatar": "",
  14.         "username": "18656660930",
  15.         "comment_num": 1,
  16.         "collection_num": 0,
  17.         "liked_num": 1
  18.     }
  19. }

编辑帖子详情

PUT /api/card/{pk}

  1. {
  2.     "Authorization": " Token c8b1243cc508efc1e0d07e7a4091cee566d9976320edab08ea86886eeb27"
  3. }
参数 类型 必须 说明
pk 整型 是 帖子主键ID(url)
card_title 字符串 是 标题
card_content 字符串 是 内容
topic 整型 是 所属话题 
  1. {
  2.     "code": 0,
  3.     "status": "success",
  4.     "message": {
  5.         "id": 1,
  6.         "created_at": "2018-01-23 10:35:15",
  7.         "updated_at": "2018-01-23 10:59:59",
  8.         "card_title": "标题2",
  9.         "card_content": "内容",
  10.         "see_num": 0,
  11.         "topic": 2,
  12.         "user": 1
  13.     }
  14. }

删除帖子

DELETE /api/card/{pk}

  1. {
  2.     "Authorization": " Token c8b1243cc508efc1e0d07e7a4091cee566d9976320edab08ea86886eeb27"
  3. }
参数 类型 必须 说明
pk 整型 是 帖子主键ID(url) 
  1. {
  2.     "code": 0,
  3.     "status": "success",
  4.     "message": ""
  5. }

判断是否已点赞该帖子

GET /api/card_liked/{pk}

  1. {
  2.     "Authorization": " Token c8b1243cc508efc1e0d07e7a4091cee566d9976320edab08ea86886eeb27"
  3. }
参数 类型 必须 说明
pk 整型 是 帖子主键ID(url) 
  1. {
  2.     "code": 0,
  3.     "status": "success",
  4.     "message": {
  5.         "id": 2,
  6.         "created_at": "2018-01-29 15:38:14",
  7.         "updated_at": "2018-01-29 15:38:14",
  8.         "is_read": false,
  9.         "card": 3,
  10.         "user": 1
  11.     }
  12. }

点赞帖子

POST /api/card_liked

  1. {
  2.     "Authorization": " Token c8b1243cc508efc1e0d07e7a4091cee566d9976320edab08ea86886eeb27"
  3. }
参数 类型 必须 说明
card 整型 是 帖子主键ID 
  1. {
  2.     "code": 0,
  3.     "status": "success",
  4.     "message": {
  5.         "id": 2,
  6.         "created_at": "2018-01-29 15:38:14",
  7.         "updated_at": "2018-01-29 15:38:14",
  8.         "is_read": false,
  9.         "card": 3,
  10.         "user": 1
  11.     }
  12. }

取消点赞帖子

DELETE /api/card_liked/{pk}

  1. {
  2.     "Authorization": " Token c8b1243cc508efc1e0d07e7a4091cee566d9976320edab08ea86886eeb27"
  3. }
参数 类型 必须 说明
pk 整型 是 帖子主键ID(url) 
  1. {
  2.     "code": 0,
  3.     "status": "success",
  4.     "message": ""
  5. }

获取帖子评论列表

GET /api/comment

  1. {
  2.     "Authorization": " Token c8b1243cc508efc1e0d07e7a4091cee566d9976320edab08ea86886eeb27"
  3. }
参数 类型 必须 说明
card 整型 是 帖子主键ID
page 整型 可选 分页页数 
  1. {
  2.     "code": 0,
  3.     "status": "success",
  4.     "message": {
  5.         "total": 1,
  6.         "pages": 1,
  7.         "current_page": 1,
  8.         "page_size": 20,
  9.         "data": [
  10.             {
  11.                 "id": 1,
  12.                 "created_at": "2018-01-29T15:54:53.524999",
  13.                 "updated_at": "2018-01-29T15:54:53.524999",
  14.                 "comment_content": "明天必涨",
  15.                 "card_id": 3,
  16.                 "user_id": 1,
  17.                 "avatar": "",
  18.                 "username": "18656660930",
  19.                 "num": null
  20.             }
  21.         ]
  22.     }
  23. }

评论帖子

POST /api/comment

  1. {
  2.     "Authorization": " Token c8b1243cc508efc1e0d07e7a4091cee566d9976320edab08ea86886eeb27"
  3. }
参数 类型 必须 说明
comment_content 字符串 是 评论内容
card 整型 是 帖子主键ID

删除评论

DELETE /api/comment/{pk}

  1. {
  2.     "Authorization": " Token c8b1243cc508efc1e0d07e7a4091cee566d9976320edab08ea86886eeb27"
  3. }
参数 类型 必须 说明
pk 整型 是 评论主键ID(url)

判断是否已点赞该评论

GET /api/comment_liked/{pk}

  1. {
  2.     "Authorization": " Token c8b1243cc508efc1e0d07e7a4091cee566d9976320edab08ea86886eeb27"
  3. }
参数 类型 必须 说明
pk 整型 是 评论主键ID 
  1. {
  2.     "code": 0,
  3.     "status": "success",
  4.     "message": {
  5.         "id": 1,
  6.         "created_at": "2018-01-29 17:14:42",
  7.         "updated_at": "2018-01-29 17:14:42",
  8.         "is_read": false,
  9.         "comment": 1,
  10.         "user": 1
  11.     }
  12. }

点赞评论

POST /api/comment_liked

  1. {
  2.     "Authorization": " Token c8b1243cc508efc1e0d07e7a4091cee566d9976320edab08ea86886eeb27"
  3. }
参数 类型 必须 说明
comment 整型 是 评论主键ID(url) 
  1. {
  2.     "code": 0,
  3.     "status": "success",
  4.     "message": {
  5.         "id": 1,
  6.         "created_at": "2018-01-29 17:14:42",
  7.         "updated_at": "2018-01-29 17:14:42",
  8.         "is_read": false,
  9.         "comment": 1,
  10.         "user": 1
  11.     }
  12. }

取消点赞评论

DELETE /api/comment_liked/{pk}

  1. {
  2.     "Authorization": " Token c8b1243cc508efc1e0d07e7a4091cee566d9976320edab08ea86886eeb27"
  3. }
参数 类型 必须 说明
pk 整型 是 评论主键ID(url) 
  1. {
  2.     "code": 0,
  3.     "status": "success",
  4.     "message": ""
  5. }

判断是否已收藏该帖子

GET /api/card_collection/{pk}

  1. {
  2.     "Authorization": " Token c8b1243cc508efc1e0d07e7a4091cee566d9976320edab08ea86886eeb27"
  3. }
参数 类型 必须 说明
pk 整型 是 帖子主键ID(url) 
  1. {
  2.     "code": 0,
  3.     "status": "success",
  4.     "message": ""
  5. }

获取收藏帖子列表

GET /api/card_collection

  1. {
  2.     "Authorization": " Token c8b1243cc508efc1e0d07e7a4091cee566d9976320edab08ea86886eeb27"
  3. }
  1. {
  2.     "code": 0,
  3.     "status": "success",
  4.     "message": {
  5.         "total": 1,
  6.         "pages": 1,
  7.         "current_page": 1,
  8.         "page_size": 20,
  9.         "data": [
  10.             {
  11.                 "id": 3,
  12.                 "created_at": "2018-01-29T15:15:48.004617",
  13.                 "updated_at": "2018-01-29T15:15:48.004617",
  14.                 "card_title": "标题",
  15.                 "card_content": "内容",
  16.                 "see_num": 0,
  17.                 "topic_id": 2,
  18.                 "user_id": 1,
  19.                 "username": "18656660930",
  20.                 "avatar": ""
  21.             }
  22.         ]
  23.     }
  24. }

收藏帖子

POST /api/card_collection

  1. {
  2.     "Authorization": " Token c8b1243cc508efc1e0d07e7a4091cee566d9976320edab08ea86886eeb27"
  3. }
参数 类型 必须 说明
card 整型 是 帖子主键ID(url) 
  1. {
  2.     "code": 0,
  3.     "status": "success",
  4.     "message": {
  5.         "id": 1,
  6.         "created_at": "2018-01-30 10:46:22",
  7.         "updated_at": "2018-01-30 10:46:22",
  8.         "card": 3,
  9.         "user": 1
  10.     }
  11. }

取消收藏帖子

DELETE /api/card_collection/{pk}

  1. {
  2.     "Authorization": " Token c8b1243cc508efc1e0d07e7a4091cee566d9976320edab08ea86886eeb27"
  3. }
参数 类型 必须 说明
pk 整型 是 帖子主键ID(url) 
  1. {
  2.     "code": 0,
  3.     "status": "success",
  4.     "message": ""
  5. }

获取产品列表

GET /api/product

  1. {
  2.     "Authorization": " Token c8b1243cc508efc1e0d07e7a4091cee566d9976320edab08ea86886eeb27"
  3. }
  1. {
  3. }

获取单个产品详情

GET /api/product/{pk}

  1. {
  2.     "Authorization": " Token c8b1243cc508efc1e0d07e7a4091cee566d9976320edab08ea86886eeb27"
  3. }
  1. {
  3. }

获取自定义模式列表

GET /api/template/custom

  1. {
  2.     "Authorization": " Token c8b1243cc508efc1e0d07e7a4091cee566d9976320edab08ea86886eeb27"
  3. }
  1. {
  3. }

添加自定义模式

POST /api/template/custom

  1. {
  2.     "Authorization": " Token c8b1243cc508efc1e0d07e7a4091cee566d9976320edab08ea86886eeb27"
  3. }
参数 类型 必须 说明
template_name 字符串 是 模板名称
template_json 字符串 是 模板指令Json
product 整型 是 产品ID 
  1. {
  3. }

编辑自定义模式

PUT /api/template/custom/{pk}

  1. {
  2.     "Authorization": " Token c8b1243cc508efc1e0d07e7a4091cee566d9976320edab08ea86886eeb27"
  3. }
参数 类型 必须 说明
template_name 字符串 是 模板名称
template_json 字符串 是 模板指令Json
product 整型 是 产品ID 
  1. {
  3. }

删除自定义模式

DELETE /api/template/custom/{pk}

  1. {
  2.     "Authorization": " Token c8b1243cc508efc1e0d07e7a4091cee566d9976320edab08ea86886eeb27"
  3. }
  1. {
  3. }

获取单个自定义模式详情

GET /api/template/custom/{pk}

  1. {
  2.     "Authorization": " Token c8b1243cc508efc1e0d07e7a4091cee566d9976320edab08ea86886eeb27"
  3. }
  1. {
  3. }

获取公共模式列表

GET /api/template/common

  1. {
  2.     "Authorization": " Token c8b1243cc508efc1e0d07e7a4091cee566d9976320edab08ea86886eeb27"
  3. }
  1. {
  3. }

获取单个公共模式详情

GET /api/template/common/{pk}

  1. {
  2.     "Authorization": " Token c8b1243cc508efc1e0d07e7a4091cee566d9976320edab08ea86886eeb27"
  3. }
  1. {
  3. }
添加新批注
在作者公开此批注前，只有你和作者可见。
回复批注