Restful Api doc demo // Eric Lu's blog

FORMAT: 1A
HOST: Api Host

Group Question_Api

提问列表相关的API.

Questions

提问对象有以下属性:

id - 问题id
user_id - 用户id
subject_id - 学科id
assign_teacher - 分配老师id
content - 问题正文
audio_url - 音频地址
picture_url - 试题图片地址
point - 该题完成所获得金币点数
answer_id - 答案id
publish_time - 发布时间
assign_time - 分配时间
solved_time - 解决时间
status - 状态id（-1:删除0:等待解答1:未评价2:已评价）
subject_name - 学科名称
nick_name - 用户昵称
avatar - 头像
human_publish_time - 发布时间（人性化）
human_assign_time - 分配时间（人性化）
human_solved_time - 解决时间（人性化）
status_text - 状态文本
list_order - 排序编号

提问列表 [/questions?from={from}&&page={page}] [GET]

Parameters
- from (required, string, my、all) …问题列表选项卡 all:广场，my:我的提问
- page (default:1, integer, 1,2) …页数无参数默认第一页

Response 200 (application/json)

[
     {
         "id": "1",
         "user_id": "1",
         "subject_id": "1",
         "assign_teacher": "2",
         "content": "老师这道题怎么搞哇？",
         "audio_url": "audio-url",
         "picture_url": "picture-url",
         "points": "50",
         "answer_id": "1",
         "publish_time": "1429241653",
         "assign_time": "1429241693",
         "solved_time": "1429241753",
         "status": "1",
         "subject_name": "小学语文",
         "nick_name": "eric_lu",
         "avatar": "''",
         "human_publish_time": "2星期前",
         "human_assign_time": "2星期前",
         "status_text": "未评价",
         "human_solved_time": "1分钟内被解决"
     }
 ]

Response 404 (application/json)

{
    "error": "没有找到任何提问"
}

Question

单个提问对象有以下属性:

question_info - 提问信息
- asw_knowledge - 试题知识点
- asw_content - 解答内容
- asw_picture_url - 解答图片地址
- asw_audio_url - 解答音频地址
follow_info - 追问信息
- id - 追问id
- question_id - 试题id
- user_id - 用户id
- body - 追问内容
- audio_url - 追问音频
- type - 追问类型（1：问 2：答）
- create_time - 创建时间
teacher_info - 解答老师信息
- id - 老师id
- nick_name - 老师昵称
- avatar - 老师头像
- area_name - 所在地区
- subject_name - 教授学科
- level - 老师级别（V1-V5）

提问详情 [/question/id/{id}] [GET]

Parameters
- id (required, number, 1) … 提问ID 类型:integer

Response 200 (application/json)

{
    "question_info": {
        "id": "1",
        "user_id": "1",
        "subject_name": "小学语文",
        "assign_teacher": "2",
        "content": "老师这道题怎么搞哇？",
        "audio_url": "audio-url",
        "picture_url": "picture-url",
        "points": "50",
        "status": "1",
        "asw_knowledge": "三角函数",
        "asw_content": "这道题的解法很简单！",
        "asw_picture_url": ["answer_picture_url_1","answer_picture_url_2"],
        "asw_audio_url": "answer_audio_url"
    },
    "follow_info": [
        {
            "id": "1",
            "question_id": "1",
            "user_id": "1",
            "body": "你的答案我看不懂啊",
            "audio_url": null,
            "type": "1",
            "create_time": "0"
        },
        {
            "id": "2",
            "question_id": "1",
            "user_id": "1",
            "body": "看不懂管我毛事",
            "audio_url": null,
            "type": "2",
            "create_time": "0"
        }
    ],
    "teacher_info": {
        "id": "2",
        "nick_name": "王老师",
        "avatar": "''",
        "area_name": "北京",
        "subject_name": "小学语文",
        "level": "V1"
    }
}

Response 400 (application/json)
```
{
    “error”: "缺少参数"
}
```

Response 404 (application/json)

{
    “error”: "该提问不存在"
}

提交提问 [/question] [POST]

Parameters
- subject - 学科id
- photo_file_name - 图片文件名
- audio_file_name - 音频文件名
- description - 问题描述（问题描述不能超过100个字符）

body (application/json)

{
    "subject": "1",
    "photo_file_name": "photo_file_name",
    "audio_file_name": "audio_file_name",
    "description": "问题描述"
}

Response 201 (application/json)
```
{
    “question_id”: "1"
}
```

Response 400 (application/json)

{
    “error”: "试题创建失败"
}

Response 422 (application/json)
```
{
    “error”: "缺少学科"
}
```

Response 422 (application/json)

{
    “error”: "声音和图片至少选一项"
}

Response 422 (application/json)

{
    “error”: "问题描述不能超过100个字符"
}

提问修改(该接口目前只在老师端抢题时使用) [/question/id/{id}] [PUT]

提问提交属性:

assign_teacher - 分配老师（只在老师抢题时用）

Parameters
- id (required, number, 1) … 提问ID 类型:integer

body (application/json)
```
{
    "assign_teacher": "3"
}
```

Response 200 (application/json)
```
{
    “question_id”: "1"
}
```

Response 404 (application/json)

{
    “error”: "该提问不存在"
}

Response 400 (application/json)

{
    “error”: "试题修改失败"
}