[关闭]
@cfygaoyang 2018-08-22T10:23:54.000000Z 字数 4724 阅读 574

接口文档

账号体系

获取验证码

POST /api/auth/send_code

参数 类型 必须 说明
account 字符串 是 手机或邮箱 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {}
  5. }

校验验证码

POST /api/auth/check_code

参数 类型 必须 说明
account 字符串 是 手机或邮箱
code 字符串 是 验证码 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "access_token": "4kbv6KFHyIJ4JECtFuRLZreHRwDz3Yo6f19fgpu5VYgnSIegN1",
  6.         "refresh_token": "pdgSDcfbZsEijvB1yH6RVGXutQWM4fF5qcCxz033AhaokshiwU",
  7.         "expires_at": "2018-08-23T10:47:16.602287",
  8.         "expires_in": 68400
  9.     }
  10. }

获取 token

POST /api/auth/access_token

参数 类型 必须 说明
account 字符串 是 手机或邮箱
password 字符串 是 密码 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "access_token": "4kbv6KFHyIJ4JECtFuRLZreHRwDz3Yo6f19fgpu5VYgnSIegN1",
  6.         "refresh_token": "pdgSDcfbZsEijvB1yH6RVGXutQWM4fF5qcCxz033AhaokshiwU",
  7.         "expires_at": "2018-08-23T10:47:16.602287",
  8.         "expires_in": 68400
  9.     }
  10. }

刷新 token

POST /api/auth/refresh_token

参数 类型 必须 说明
refresh_token 字符串 是 刷新token 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "access_token": "4kbv6KFHyIJ4JECtFuRLZreHRwDz3Yo6f19fgpu5VYgnSIegN1",
  6.         "refresh_token": "pdgSDcfbZsEijvB1yH6RVGXutQWM4fF5qcCxz033AhaokshiwU",
  7.         "expires_at": "2018-08-23T10:47:16.602287",
  8.         "expires_in": 68400
  9.     }
  10. }

销毁 token

POST /api/auth/destroy_token

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {}
  5. }

重置密码

POST /api/auth/reset_password

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

重置用户名

POST /api/auth/reset_username

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
username 字符串 是 用户名 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {}
  5. }

用户信息

获取个人信息

GET /api/user

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "id": 1,
  6.         "app_id": null,
  7.         "created_at": "2018-08-22T16:06:00.524028",
  8.         "updated_at": "2018-08-22T16:06:00.524334",
  9.         "avatar": null,
  10.         "birthday": null,
  11.         "sex": 2,
  12.         "city": null,
  13.         "address": null,
  14.         "company": null,
  15.         "job": null,
  16.         "name": null,
  17.         "age": 0,
  18.         "user": 4,
  19.         "username": "jerry",
  20.         "phone": "18656660930",
  21.         "email": null
  22.     }
  23. }

编辑个人信息

PUT /api/user

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
avatar 字符串 可选 头像
birthday 字符串 可选 生日
sex 整型 可选 性别：0女1男2保密
city 字符串 可选 城市
address 字符串 可选 地址
company 字符串 可选 公司
job 字符串 可选 职称
name 字符串 可选 姓名
age 字符串 可选 年龄 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "id": 1,
  6.         "app_id": null,
  7.         "created_at": "2018-08-22T16:06:00.524028",
  8.         "updated_at": "2018-08-22T16:06:00.524334",
  9.         "avatar": null,
  10.         "birthday": null,
  11.         "sex": 2,
  12.         "city": null,
  13.         "address": null,
  14.         "company": null,
  15.         "job": null,
  16.         "name": null,
  17.         "age": 0,
  18.         "user": 4,
  19.         "username": "jerry",
  20.         "phone": "18656660930",
  21.         "email": null
  22.     }
  23. }

获取用户信息

GET /api/user/{id}

  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "id": 2,
  6.         "app_id": null,
  7.         "created_at": "2018-08-22T16:19:29.021429",
  8.         "updated_at": "2018-08-22T16:19:29.021708",
  9.         "avatar": null,
  10.         "birthday": null,
  11.         "sex": 2,
  12.         "city": null,
  13.         "address": null,
  14.         "company": null,
  15.         "job": null,
  16.         "name": null,
  17.         "age": 0,
  18.         "user": 3,
  19.         "username": "admin"
  20.     }
  21. }

主题（栏目）

获取主题列表

GET /api/topic

参数 类型 必须 说明
parent_id 整型 可选 所属父级主题id
page 整型 可选 页数

* 请求回调

  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "total": 2,
  6.         "pages": 1,
  7.         "current_page": 1,
  8.         "page_size": 20,
  9.         "data": [
  10.             {
  11.                 "id": 2,
  12.                 "app_id": "",
  13.                 "created_at": "2018-08-21T16:08:25.355650",
  14.                 "updated_at": "2018-08-21T16:08:25.547252",
  15.                 "name": "mulu2",
  16.                 "index": 1,
  17.                 "status": true,
  18.                 "parent_id": 0
  19.             },
  20.             {
  21.                 "id": 1,
  22.                 "app_id": "",
  23.                 "created_at": "2018-08-20T13:54:55.088446",
  24.                 "updated_at": "2018-08-21T16:08:25.687894",
  25.                 "name": "人工智能",
  26.                 "index": 2,
  27.                 "status": true,
  28.                 "parent_id": 0
  29.             }
  30.         ]
  31.     }
  32. }

获取主题详情

GET /api/topic/{id}

  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "id": 1,
  6.         "app_id": "",
  7.         "created_at": "2018-08-20T13:54:55.088446",
  8.         "updated_at": "2018-08-21T16:08:25.687894",
  9.         "name": "人工智能",
  10.         "index": 2,
  11.         "status": true,
  12.         "parent_id": 0
  13.     }
  14. }

文章

获取文章列表

GET /api/article

参数 类型 必须 说明
topic 整型 可选 所属主题id
page 整型 可选 页数
author 整型 可选 用户id 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "total": 1,
  6.         "pages": 1,
  7.         "current_page": 1,
  8.         "page_size": 20,
  9.         "data": [
  10.             {
  11.                 "id": 1,
  12.                 "app_id": "",
  13.                 "created_at": "2018-08-20T16:28:26.899972",
  14.                 "updated_at": "2018-08-20T16:28:26.900172",
  15.                 "title": "标题",
  16.                 "content": "内容",
  17.                 "author": 0,
  18.                 "topic": 1,
  19.                 "username": null,
  20.                 "name": "人工智能"
  21.             }
  22.         ]
  23.     }
  24. }

添加文章

POST /api/article

参数 类型 必须 说明
title 字符串 是 标题
content 字符串 是 内容
topic 整型 可选 所属话题id 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "id": 2,
  6.         "app_id": null,
  7.         "created_at": "2018-08-22T18:13:47.729039",
  8.         "updated_at": "2018-08-22T18:13:47.729193",
  9.         "title": "标题",
  10.         "content": "内容",
  11.         "author": 0,
  12.         "topic": 1
  13.     }
  14. }

获取文章详情

GET /api/article/{id}

  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "id": 2,
  6.         "app_id": null,
  7.         "created_at": "2018-08-22T18:13:47.729039",
  8.         "updated_at": "2018-08-22T18:13:47.729193",
  9.         "title": "标题",
  10.         "content": "内容",
  11.         "author": 0,
  12.         "topic": 1
  13.     }
  14. }

编辑文章

PUT /api/article/{id}

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
title 字符串 是 标题
content 字符串 是 内容
topic 整型 可选 所属话题id 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "id": 2,
  6.         "app_id": null,
  7.         "created_at": "2018-08-22T18:13:47.729039",
  8.         "updated_at": "2018-08-22T18:13:47.729193",
  9.         "title": "标题",
  10.         "content": "内容",
  11.         "author": 0,
  12.         "topic": 1
  13.     }
  14. }

删除文章

DELETE /api/article/{id}

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {}
  5. }
添加新批注
在作者公开此批注前，只有你和作者可见。
回复批注