markdown编写规范API文档

1 学生管理（接口包）
- 1.1 接口标题（格式示例）
- 1.2 单个学生登录（DEMO）

随技术不断发展，服务端和前端及其各方的逻辑交互，走向了一种更为规范的道路。因此，从个人能力，或是团队协作的角度出发，编写规范的 API 文档成为了一种不可缺少的能力。
　　以下是以 markdown 文档方式编写的一组 API DEMO ，选用 markdown 作为 API 编写工具是因为，markdown 特来了很纯粹的文档内容，并且可以优于 word 等方案的版本管理优点，文档的任何变动，可以以 diff 的方式像代码一样的查看到文档的修改细节；从可读性方面，markdown 完全可以加入自己所需要的样式编译输出为纯静态的 html 文档，再配合一些目前开源的工具，完全可以实现更多的功能。

1 学生管理（接口包）

1.1 接口标题（格式示例）

描述：
　接口相关说明
请求URL：
　http://xx.xx.com:80/xxx/
请求方式：
　GET
参数：

参数名	必选	类型	说明
xxxx	是	string	参数说明

返回示例：

{
    xxx: xx
    ...
}

返回参数说明：

参数名	类型	说明
status	int	1：为成功；0：为失败

备注：
　其他相关内容说明

1.2 单个学生登录（DEMO）

描述：
　学生登录接口，账号由教师一键生成，默认密码 123456。
请求URL：
　https://xxx.xxx.com:8080/student/login
请求方式：
　POST
参数：

参数名	必选	类型	说明
idcard	是	string	身份证号码
password	是	string	密码

返回示例：

1
2
3

{
    'res': 1
}

返回参数说明：

参数名	类型	说明
res	int	1 为成功 0为失败