要做到前后端分离，那么就不能互相干扰。而前后端唯一的交流就是接口文档。

接口文档是什么

在项目开发汇总，web项目的前后端是分离开发的。应用程序的开发，需要由前后端工程师共同定义接口，编写接口文档，之后大家都根据这个接口文档进行开发，到项目结束前都要一直维护。

为什么要写接口文档

1）项目开发过程中前后端工程师有一个统一的文件进行沟通交流开发
2）项目维护中或者项目人员更迭的时候，方便后期人员查看、维护

接口文档分为四部分：url、方法、请求参数、返回参数

url

即接口地址，通过处理器函数与路由绑定

方法

常用的方法就是下面的四种：GET PUT POST DELETE

请求参数

名称、类型、说明、必填这四项是必须要有的

返回参数

一般至少要有返回参数、参数类型和类型说明三部分

其他

像是备注、接口说明等在需要时需要加上

一个例子

登录

接口地址：/login

首先判断token

返回格式：json

返回示例：

/*成功示例*/
{
    "Code":301,//找到token信息，免登录跳转管理员页面
    "Message":"redict"
}
{
    "Code":302,//找到token信息，免登录跳转学生页面
    "Message":"redict"
}
/*失败示例*/
{
    "Code":201,//未找到token信息
    "Message":"no message"
}

返回参数：

备注：根据Code跳转不同页面，管理员主界面 301，用户主界面 302

未找到token，需输入账号密码：

请求格式：json

请求方式：http post

接口备注：接口需要返回三条信息，分别是身份信息、账号和密码。其中身份区分管理员和普通用户，账号密码用作验证。

请求参数说明：

返回格式：json

返回示例：

/*成功示例*/
{
    "Code":301,//跳转页面
    "Message":"redict"
}
{
    "Code":302,//跳转页面
    "Message":"redict"
}
/*失败示例*/
{
    "Code":400,//账号密码错误
    "Message":"error"
}

返回参数：

返回参数说明：根据Code跳转不同页面，管理员主界面 301，用户主界面 302

仅供参考。