Markdown接口文档

1. 环境部署/安装

文档基于 gitbook 运行的，所以需要配置 gitbook 的运行环境，配置过程如下：

1.1 克隆源代码

> git clone 

1.2. 配置本地运行环境

./configure
make
make install 

2). 安装gitbook

npm install gitbook-cli -g

如果安装太慢，可以设置淘宝代理镜像，执行命令：

npm config set registry https://registry.npm.taobao.or

查看gitbook是否安装成功：

gitbook -V

使用

进入api-doc目录，执行命令：

gitbook serve

2. 文档使用说明

2.1版本历史

2.2 文档介绍

本文档的接口遵循RESTful设计风格...。

2.3接口约定

2.3.1 登录认证流程

基于JWT认证机制，实现登录认证流程...。

2.3.2 Token 验证

Token访问有效期为两个小时，刷新有效期为两周...。

注意事项：...。

2.3.3 返回结果

所有返回结果以 JSON 格式返回；接口返回一共有三种情况：

1. 操作成功后返回，范例：

{
  "code": "200",//状态码
  "msg": "SUCCESS"//信息
} 

2. 成功返回数据，范例：

{
  "data": {//数据
    "name": "minhow",
    "age": "18"
  },
  "code": "200",//状态码
  "msg": "SUCCESS"//信息
}

3. 错误返回，范例：

{
  "err_code": "1001",//错误状态码
  "err_msg": "认证失败，请重新登录！"//错误信息
}

2.3.4 全局响应状态码说明

3. 目录

4. 接口说明

登录案例如下：

1. 登录

1.1 功能描述

提供手机号和密码的登录方式。

1.2 请求说明

1.3 请求参数

1.4 返回结果

{
  "data": {
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vc2FsZS1hcGkuZGV2L2xvZ2luIiwiaWF0IjoxNDkxNTMyOTI4LCJleHAiOjE0OTIyNTI5MjgsIm5iZiI6MTQ5MTUzMjkyOCwianRpIjoiN1hCUXdwN1FHZmxUdHVVQiIsInV1aWQiOiI1MDZjYWY3MCJ9.FyyXagHtBfDBtMJZPV_hm2q6CVULpY63JPDGDHXc"
  },
  "code": "200",
  "msg": "SUCCESS"
}

1.5 返回参数

1.6 错误状态码

部分代码如下：

## 1. 登录
### 1.1 功能描述
提供手机号和密码的登录方式。
### 1.2 请求说明
> 请求方式：POST<br>
请求URL ：[login](#)

### 1.3 请求参数
字段       |字段类型       |字段说明
------------|-----------|-----------
phone       |int        |手机号
password       |string        |密码
### 1.4 返回结果
```json  
{
  "data": {
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vc2FsZS1hcGkuZGV2L2xvZ2luIiwiaWF0IjoxNDkxNTMyOTI4LCJleHAiOjE0OTIyNTI5MjgsIm5iZiI6MTQ5MTUzMjkyOCwianRpIjoiN1hCUXdwN1FHZmxUdHVVQiIsInV1aWQiOiI1MDZjYWY3MCJ9.FyyXagHtBfDBtMJZPV_hm2q6CVULpY63JPDGDHXc"
  },
  "code": "200",
  "msg": "SUCCESS"
}

### 1.5 返回参数
字段       |字段类型       |字段说明
------------|-----------|-----------
token       |string        |token值
### 1.6 错误状态码
状态码       |说明
------------|-----------
3001       |其他认证错误信息！
3002       |用户不存在！
3003       |用户名或密码有误！