[关闭]
@fuyb1986 2016-06-28T14:41:08.000000Z 字数 11669 阅读 618

问答文档

欣略

1. 创建问题

Description

用户创建问题

Method and URL Structure

Method Resource URL
POST /qa/questions/

Request Parameters

Name Description Required Default
node 所属分类资源的pk／id No
title 问题题目 Yes
content 问题内容 NO

Request Header

Name Description Required Default
Authorization Token 7309fabd207c22e0a00eada158989b89ffe839ef Yes

＊Authorization的值为登录成功后返回值

Request

  1. {
  2.     "node":1,
  3.     "title":"今天",
  4.     "content":"今天怎么样？",
  5. }

cURL Example

  1. curl -X POST -H 'Authorization: Token 7309fabd207c22e0a00eada158989b89ffe839ef' \
  2. -d '{"node":1, "title":"今天", "content":"天怎么样?"}' \
  3. http://127.0.0.1:8000/qa/questions/

JSON Response

  1. {
  2.     "pk": 5,
  3.     "author": "15670502158",
  4.     "node": 1,
  5.     "title": "今天",
  6.     "content": "今天怎么样?",
  7.     "click": 0,
  8.     "reply_count": 0,
  9.     "create_time": "2016-04-14T02:43:29.501034Z",
  10.     "last_replied": "2016-04-14T02:43:29.501073Z",     
  11.     "profile": {
  12.         "pk": 2,
  13.         "owner": "18516271364",
  14.         "nickname": "小明",
  15.         "avatar_url": "http://example.com/n.png",
  16.         "website": "http://www.example.com",
  17.     }
  18. }

2. 修改问题

Description

用户修改问题信息

Method and URL Structure

Method Resource URL
PUT /qa/questions/${pk}/

Request Parameters

Name Description Required Default
node 所属分类资源的pk／id No
title 问题题目 Yes
content 问题内容 NO

Request Header

Name Description Required Default
Authorization Token 7309fabd207c22e0a00eada158989b89ffe839ef Yes

＊Authorization的值为登录成功后返回值

Request

  1. {
  2.     "node":2,
  3.     "title":"我好",
  4.     "content":"今天过的很happy",
  5. }

cURL Example

  1. curl -X PUT -H 'Authorization: Token 7309fabd207c22e0a00eada158989b89ffe839ef' \
  2. -d '{"title":"我好","content":"今天很快乐?"}' \
  3. http://127.0.0.1:8000/qa/questions/1/

JSON Response

  1. {
  2.     "pk": 1,
  3.     "author": "teacher",
  4.     "node": 2,
  5.     "title": "我好",
  6.     "content": "今天很快乐?",
  7.     "click": 0,
  8.     "reply_count": 0,
  9.     "create_time": "2016-04-14T02:19:48.935635Z",
  10.     "last_replied": "2016-04-14T02:19:48.935678Z",
  11.     "profile": {
  12.         "pk": 2,
  13.         "owner": "18516271364",
  14.         "nickname": "小明",
  15.         "avatar_url": "http://wwww.example/image/1.png",
  16.         "website": "http://www.exmple.com/"
  17.     }
  18. }

3. 删除问题

Description

用户删除问题信息

Method and URL Structure

Method Resource URL
DELETE /qa/questions/${pk}/

Request Header

Name Description Required Default
Authorization Token 7309fabd207c22e0a00eada158989b89ffe839ef Yes

＊Authorization的值为登录成功后返回值

cURL Example

  1. curl -X DELETE -H 'Authorization: Token 7309fabd207c22e0a00eada158989b89ffe839ef' http://127.0.0.1:8000/qa/questions/1/

JSON Response

Name Description Default
detail 失败原因 Not found
status 成功 204

4. 查看具体问题

Description

用户查询某一问题信息

Method and URL Structure

Method Resource URL
GET /qa/questions/${pk}/

Request Header

Name Description Required Default
Authorization Token 7309fabd207c22e0a00eada158989b89ffe839ef Yes

＊Authorization的值为登录成功后返回值

cURL Example

  1. curl -X GET -H 'Authorization: Token 7309fabd207c22e0a00eada158989b89ffe839ef' http://127.0.0.1:8000/qa/questions/1/

JSON Response

  1. {
  2.     "pk": 1,
  3.     "author": "15670502158",
  4.     "node": null,
  5.     "title": "数学问题1",
  6.     "content": "1＋ 1=?\r\n从哲学的角度来说，1+1=？，然后从数学的角度又是多少",
  7.     "click": 5,
  8.     "reply_count": 2,
  9.     "create_time": "2016-05-31T07:43:36.002513Z",
  10.     "last_replied": "2016-06-03T08:24:42.245772Z",
  11.     "profile": {
  12.         "pk": 2,
  13.         "owner": "18516271364",
  14.         "nickname": "小明",
  15.         "avatar_url": "http://www.example.cm/3.png",
  16.         "website": "http://www.example.com/",
  17.     }
  18. }

5. 获取所有问题

Description

用户查看所有问题信息

Method and URL Structure

Method Resource URL
GET /qa/questions/

Request Parameters

默认分页取数据库中最新的10条数据

Name Description Required Default
page page Number Yes 1

Request Header

Name Description Required Default
Authorization Token 7309fabd207c22e0a00eada158989b89ffe839ef Yes

＊Authorization的值为登录成功后返回值

cURL Example

  1. curl -X GET -H 'Authorization: Token 7309fabd207c22e0a00eada158989b89ffe839ef' http://127.0.0.1:8000/qa/questions/?page=1

JSON Response

  1. {
  2.     "count": 4,
  3.     "next": null,
  4.     "previous": null,
  5.     "results": [
  6.         {
  7.             "pk": 5,
  8.             "author": "teacher",
  9.             "node": 1,
  10.             "title": "今天",
  11.             "content": "今天怎么样?",
  12.             "click": 0,
  13.             "reply_count": 0,
  14.             "create_time": "2016-04-14T02:43:29.501034Z",
  15.             "last_replied": "2016-04-14T02:43:29.501073Z",
  16.             "profile": {
  17.                 "pk": 3,
  18.                 "username": "15670502158",
  19.                 "nickname": "小花",
  20.                 "avatar_url": "http://pic.example.com/img/3.png",
  21.                 "website": "http://www.example.com/",
  22.             }
  23.         },
  24.         {
  25.             "pk": 4,
  26.             "author": "teacher",
  27.             "node": null,
  28.             "title": "今天",
  29.             "content": "今天怎么样?",
  30.             "click": 0,
  31.             "reply_count": 0,
  32.             "create_time": "2016-04-14T02:43:13.574751Z",
  33.             "last_replied": "2016-04-14T02:43:13.574794Z",
  34.             "profile": {
  35.                 "pk": 2,
  36.                 "owner": "18516271364",
  37.                 "nickname": "小明",
  38.                 "avatar_url": "http://pic3.example.com/3.png",
  39.                 "website": "http://www.example.com",
  40.             },
  41.         },
  42.         ......
  43.     ]
  44. }

6. 根据关键字搜索和排序问题

Description

用户根据关键字搜索和排序相关问题

Method and URL Structure

Method Resource URL
GET /qa/questions/

Request Parameters

默认分页取数据库中最新的10条数据

Name Description Required Default
page page Number Yes 1
search 搜索字段 No
ordering 排序字段 No
  • search，搜索字段，模糊搜索，根据问题标题、问题作者、问题内容
  • ordering,排序字段，问题点击数(click)、问题回复数(reply_count)、
  • ordering=click,代表从小到大，ordering=-click,代表从大到小

Request Header

Name Description Required Default
Authorization Token 7309fabd207c22e0a00eada158989b89ffe839ef Yes

＊Authorization的值为登录成功后返回值

cURL Example

  1. curl -X GET -H 'Authorization: Token 7309fabd207c22e0a00eada158989b89ffe839ef' http://127.0.0.1:8000/qa/questions/?search=辰&ordering=-click&page=1

JSON Response

  1. {
  2.     "count": 2,
  3.     "next": null,
  4.     "previous": null,
  5.     "results": [
  6.         {
  7.             "pk": 2,
  8.             "author": "15201052252",
  9.             "node": null,
  10.             "title": "今天",
  11.             "content": "请以今天为题目写一篇不少于500字的作文",
  12.             "click": 4,
  13.             "reply_count": 0,
  14.             "create_time": "2016-05-31T07:49:58.702588Z",
  15.             "last_replied": "2016-05-31T07:49:58.702627Z",
  16.            "profile": {
  17.                "pk": 2,
  18.                "owner": "18516271364",
  19.                "nickname": "小明",
  20.                "avatar_url": "http://www.example.com/3.png",
  21.                "website": "http://example.com",
  22.             },
  23.         },
  24.         {
  25.             "pk": 3,
  26.             "author": "15201052252",
  27.             "node": null,
  28.             "title": "明天",
  29.             "content": "明天怎么样?",
  30.             "click": 0,
  31.             "reply_count": 0,
  32.             "create_time": "2016-06-03T07:52:34.402926Z",
  33.             "last_replied": "2016-06-03T07:52:34.402965Z",
  34.             "profile": {
  35.                "pk": 1,
  36.                "owner": "18516271364",
  37.                "nickname": "小明",
  38.                "avatar_url": "http://example.com/3.png",
  39.                "website": "http://www.example.com/"
  40.             }
  41.         }
  42.     ]
  43. }

1. 给问题添加答案

Description

用户给问题添加答案

Method and URL Structure

Method Resource URL
POST /qa/answers/

Request Parameters

Name Description Required Default
question 问题资源的pk／id Yes
content 答案内容 NO

Request Header

Name Description Required Default
Authorization Token 7309fabd207c22e0a00eada158989b89ffe839ef Yes

＊Authorization的值为登录成功后返回值

Request

  1. {
  2.     "question":1,
  3.     "content":"今天怎么样？",
  4. }

cURL Example

  1. curl -X POST -H 'Authorization: Token 7309fabd207c22e0a00eada158989b89ffe839ef' -d 'question=1&content=开心就好' http://127.0.0.1:8000/qa/answers/

JSON Response

  1. {
  2.     "pk": 2,
  3.     "author": "teacher",
  4.     "question": 1,
  5.     "content": "开心就好",
  6.     "create_time": "2016-04-14T03:49:50.504486Z",
  7.     "adopt": false,
  8.     "highlight": false,
  9.     "profile": {
  10.         "pk": 1,
  11.         "username": "15201052252",
  12.         "nickname": "晓辰",
  13.         "avatar_url": "http://123.jpg",
  14.         "website": "http://123.html",
  15.     }
  16. }

2. 修改答案

Description

用户修改答案信息

Method and URL Structure

Method Resource URL
PUT /qa/answers/${pk}/

Request Parameters

Name Description Required Default
content 问题内容 NO

Request Header

Name Description Required Default
Authorization Token 7309fabd207c22e0a00eada158989b89ffe839ef Yes

＊Authorization的值为登录成功后返回值

Request

  1. {
  2.     "content":"今天过的很happy",
  3. }

cURL Example

  1. curl -X PUT -H 'Authorization: Token 7309fabd207c22e0a00eada158989b89ffe839ef' -d '&content=今天很快乐?' http://127.0.0.1:8000/qa/answers/1/

JSON Response

  1. {
  2.     "pk": 1,
  3.     "author": "teacher",
  4.     "question": 1,
  5.     "content": "今天很快乐?",
  6.     "create_time": "2016-04-14T03:48:58.201482Z",
  7.     "adopt": true,
  8.     "highlight": true,
  9.     "profile": {
  10.         "pk": 1,
  11.         "username": "15201052252",
  12.         "nickname": "晓辰",
  13.         "avatar_url": "http://123.jpg",
  14.         "website": "http://123.html",
  15.     }
  16. }

3. 删除答案

Description

用户删除答案信息

Method and URL Structure

Method Resource URL
DELETE /qa/answers/${pk}/

Request Header

Name Description Required Default
Authorization Token 7309fabd207c22e0a00eada158989b89ffe839ef Yes

＊Authorization的值为登录成功后返回值

cURL Example

  1. curl -X DELETE -H 'Authorization: Token 7309fabd207c22e0a00eada158989b89ffe839ef' http://127.0.0.1:8000/qa/answers/1/

JSON Response

Name Description Default
detail 失败原因 Not found
status 成功 204

4. 查看具体答案

Description

用户查询某一答案信息

Method and URL Structure

Method Resource URL
GET /qa/answers/${pk}/

Request Header

Name Description Required Default
Authorization Token 7309fabd207c22e0a00eada158989b89ffe839ef Yes

＊Authorization的值为登录成功后返回值

cURL Example

  1. curl -X GET -H 'Authorization: Token 7309fabd207c22e0a00eada158989b89ffe839ef' http://127.0.0.1:8000/qa/answers/1/

JSON Response

  1. {
  2.     "pk": 1,
  3.     "author": "15201052252",
  4.     "question": 1,
  5.     "content": "从数学的角度说，1 1=2，从哲学上说，1 1=田。这是我的想法。",
  6.     "create_time": "2016-05-31T07:54:59.148429Z",
  7.     "adopt": true,
  8.     "highlight": true,
  9.     "profile": {
  10.         "pk": 1,
  11.         "owner": "15201052252",
  12.         "nickname": "晓辰",
  13.         "avatar_url": "http://123.jpg",
  14.         "website": "http://123.html",
  15.     }
  16. }

5. 获取某一问题所有答案

Description

用户查看问题所有答案

Method and URL Structure

Method Resource URL
GET /qa/answers/

Request Parameters

默认分页取数据库中最新的10条数据

Name Description Required Default
page page Number Yes 1
question 某一问题资源的pk/id Yes

Request Header

Name Description Required Default
Authorization Token 7309fabd207c22e0a00eada158989b89ffe839ef Yes

＊Authorization的值为登录成功后返回值

cURL Example

  1. curl -X GET -H 'Authorization: Token 7309fabd207c22e0a00eada158989b89ffe839ef' -d 'page=1' http://127.0.0.1:8000/qa/answers/?question=1

JSON Response

  1. {
  2.     "count": 2,
  3.     "next": null,
  4.     "previous": null,
  5.     "results": [
  6.         {
  7.             "pk": 4,
  8.             "author": "teacher",
  9.             "question": 1,
  10.             "content": "开心就好",
  11.             "create_time": "2016-04-14T04:01:03.766729Z",
  12.             "adopt": true,
  13.             "highlight": true,
  14.             "profile": {
  15.                 "pk": 1,
  16.                 "owner": "15201052252",
  17.                 "nickname": "晓辰",
  18.                 "avatar_url": "http://123.jpg",
  19.                 "website": "http://123.html",
  20.             }
  22.         },
  23.         {
  24.             "pk": 3,
  25.             "author": "teacher",
  26.             "question": 1,
  27.             "content": "开心就好",
  28.             "create_time": "2016-04-14T04:01:03.766729Z",
  29.             "adopt": true,
  30.             "highlight": true,
  31.             "profile": {
  32.                 "pk": 1,
  33.                 "owner": "15201052252",
  34.                 "nickname": "晓辰",
  35.                 "avatar_url": "http://123.jpg",
  36.                 "website": "http://123.html",
  37.             }
  38.         }
  39.     ]
  40. }

1. 给答案添加评论

Description

用户给答案添加评论

Method and URL Structure

Method Resource URL
POST /qa/comments/

Request Parameters

Name Description Required Default
answer 答案资源的pk／id Yes
content 评论内容 Yes

Request Header

Name Description Required Default
Authorization Token 7309fabd207c22e0a00eada158989b89ffe839ef Yes

＊Authorization的值为登录成功后返回值

Request

  1. {
  2.     "answer":1,
  3.     "content":"今天怎么样？",
  4. }

cURL Example

  1. curl -X POST -H 'Authorization: Token 7309fabd207c22e0a00eada158989b89ffe839ef' -d 'answer=2&content=开心就好' http://127.0.0.1:8000/qa/comments/

JSON Response

  1. {
  2.     "pk": 1,
  3.     "author": "teacher",
  4.     "content": "hello",
  5.     "answer": 2,
  6.     "create_time": "2016-04-14T05:56:44.514812Z"
  7. }

2. 删除评论

Description

用户删除评论信息

Method and URL Structure

Method Resource URL
DELETE /qa/comments/${pk}/

Request Header

Name Description Required Default
Authorization Token 7309fabd207c22e0a00eada158989b89ffe839ef Yes

＊Authorization的值为登录成功后返回值

cURL Example

  1. curl -X DELETE -H 'Authorization: Token 7309fabd207c22e0a00eada158989b89ffe839ef' http://127.0.0.1:8000/qa/comments/1/

JSON Response

Name Description Default
detail 失败原因 Not found
status 成功 204

4. 查看具体评论

Description

用户查询某一评论信息

Method and URL Structure

Method Resource URL
GET /qa/comments/${pk}/

Request Header

Name Description Required Default
Authorization Token 7309fabd207c22e0a00eada158989b89ffe839ef Yes

＊Authorization的值为登录成功后返回值

cURL Example

  1. curl -X GET -H 'Authorization: Token 7309fabd207c22e0a00eada158989b89ffe839ef' http://127.0.0.1:8000/qa/comments/2/

JSON Response

  1. {
  2.     "pk": 2,
  3.     "author": "teacher",
  4.     "content": "hello",
  5.     "answer": 2,
  6.     "create_time": "2016-04-14T05:59:04.089674Z"
  7. }

5. 获取某一答案所有评论

Description

用户查看答案所有评论

Method and URL Structure

Method Resource URL
GET /qa/comments/

Request Parameters

默认分页取数据库中最新的10条数据

Name Description Required Default
page page Number Yes 1
answer 某一答案资源的pk/id Yes

Request Header

Name Description Required Default
Authorization Token 7309fabd207c22e0a00eada158989b89ffe839ef Yes

＊Authorization的值为登录成功后返回值

cURL Example

  1. curl -X GET -H 'Authorization: Token 7309fabd207c22e0a00eada158989b89ffe839ef' -d 'page=1' http://127.0.0.1:8000/qa/comments/?answer=2

JSON Response

  1. {
  2.     "count": 3,
  3.     "next": null,
  4.     "previous": null,
  5.     "results": [
  6.         {
  7.             "pk": 4,
  8.             "author": "teacher",
  9.             "content": "hello",
  10.             "answer": 2,
  11.             "create_time": "2016-04-14T05:59:11.765788Z"
  12.         },
  13.         {
  14.             "pk": 3,
  15.             "author": "teacher",
  16.             "content": "hello",
  17.             "answer": 2,
  18.             "create_time": "2016-04-14T05:59:06.878130Z"
  19.         },
  20.         {
  21.             "pk": 2,
  22.             "author": "teacher",
  23.             "content": "hello",
  24.             "answer": 2,
  25.             "create_time": "2016-04-14T05:59:04.089674Z"
  26.         }
  27.     ]
  28. }

01. 采纳答案

Description

用户采纳了回答者的答案

Method and URL Structure

Method Resource URL
PATCH /qa/adopt/${pk}/

Request Header

Name Description Required Default
Authorization Token 7309fabd207c22e0a00eada158989b89ffe839ef Yes

＊Authorization的值为登录成功后返回值

cURL Example

  1. curl -X PATCH -H 'Authorization: Token 646bae225c36ee8edb8c93d88a5f52c054a3fbeb' http://127.0.0.1:8000/qa/adopt/1/

JSON Response

  1. {
  2.     "pk": 1,
  3.     "author": "15201052252",
  4.     "question": 1,
  5.     "content": "从数学的角度说，1 1=2，从哲学上说，1 1=田。这是我的想法。",
  6.     "create_time": "2016-05-31T07:54:59.148429Z",
  7.     "adopt": true,
  8.     "highlight": true,
  9.     "profile": {
  10.         "pk": 1,
  11.         "owner": "15201052252",
  12.         "nickname": "晓辰",
  13.         "avatar_url": "http://123.jpg",
  14.         "website": "http://123.html",
  15.     }
  16. }
添加新批注
在作者公开此批注前，只有你和作者可见。
回复批注