前后端接口文档编写

前后端分离需要编写接口文档，便于前后端工程师根据接口调用数据库和系统的功能。

接口分为四部分：方法、uri、请求参数、返回参数
1、方法：新增post、修改put、获取get、删除delete
2、uri:以"/"开头定义接口
3、请求参数和返回参数
包括5个部分：字段、说明、类型、备注、是否必填字段

说明是中文释义；
类型是属性类型，只有String、Number、Object、Array四种类型；
备注是一些解释；
是否必填是字段的是否必填。

4、返回参数结构有几种情况：
1、如果只返回接口调用成功还是失败（如新增、删除、修改等），则只有一个结构体：code和message两个参数；
2、如果要返回某些参数，则有两个结构体：1是code/mesage/data，2是data里写返回的参数,data是object类型；
3、如果要返回列表，那么有三个结构体，1是code/mesage/data,data是object，里面放置page/size/total/totalPage/list 5个参数，其中list是Arrary类型，list里放object，object里是具体的参数。

例如：请求地址：get /consilia/List
请求参数：

返回参数：

参考链接