2021蓝旭后端暑期第五次培训课-接口文档设计

试卷管理员端渲染接口

1.接口描述

1. 接口请求uri: in/toAdminShow
2. content-type: get请求无需指定/post请求为application/json
3. 请求方式: get/post
4. 描述: 试卷管理员端渲染请求

2.输入参数

参数名称	必选	类型	描述
examId	是	Number	试卷id

3.输出参数

参数名称	类型	描述
examName	String	试卷名称
groupId	Array[String]	组id{六位随机字符串}
beginTime	Number	开始时间{时间戳}
endTime	Number	结束时间{时间戳}
questionList	Array[question]	题目数组
status	Number	状态值,1为成功,0为失败{1,0}
msg	string	状态描述

4.用例

输入

get请求实例：

参数名称	示例
examId	10000274

post请求示例：

{
    "examId":10000274
}

输出

成功

{
    "examName":"测试题",
    "groupId":[
        "AX1V7T",
        "BVC234"
    ],
    "beginTime":1586712717,
    "endTime":1586719999,
    "questionList":[
        {
        "title":"这是一道多选题",
        "score":20,
        "type":2,
        "current":"AB",
        "answerA":"选项a",
        "answerB":"选项b",
        "answerC":"选项c",
        "answerD":"选项d",
        "id":1
        }
    ],
    "status":1,
    "msg":"试卷渲染成功"
}

失败

{
    "status":0,
    "msg":"试卷id不存在"
}