API文档设计操作手册
一、工具选择
1. 谷歌插件FeHelper
谷歌安装 调出插件 插件页面
2. ApiPost工具
工具界面 官网下载 https://www.apipost.cn/
二、接口设计内容
1. 默认环境设置，便于开发/测试/上线快速切换
2. 接口说明
项目结构分层 接口说明进行备注
3. 接口设计
# 本地开发环境，自定义：http://localhost:8080/
# 分级模块名称，可以是多级：/contact
# 请求名称，尽可能精简，表明请求的意思：/find-education
4. 增删改查分析
类别请求方式响应体成功响应增加POSTapplication/json 数据code+message删除GETQuery 参数code+message修改POSTapplication/json 数据code+message单个查询GETQuery 参数code+message+数据集合查询POSTapplication/json 数据code+message+集合数据
5. Query简介
Query的参数名和参数值会拼接在请求URL后面
6. Body简介
Body是将大量的参数传递给前端，通常使用application/json格式进行传递。同时，我们也可以用它来编辑json格式数据：
选择数据格式为muliipart/form-data，编辑参数和数据 选择导出参数
导出类型说明作用导出带描述的参数包含编辑参数的全部属性值用于将参数内容快速导出并导入到其他接口文档中导出Key-Value 参数/学习知识少，暂时不知道有什么用处导出Raw-Json 参数json类型数据json格式数据编辑 复制参数（选择Raw-Json 参数 的导出方式）
7. 成功响应示例
{
"code": 200, # 响应码
"message": "操作成功", # 响应消息
"data": "" # 返回值
}
三、JSON格式成功响应实例
1. JSON格式说明
其实JSON数据就是一段字符串而已，只不过有不同意义的分隔符将其分割开来而已，我们看上面的符号，里面有[] ,{}等符号，其中
1 []中括号代表的是一个数组；
2 {}大括号代表的是一个对象
3 双引号“”表示的是属性值
4 冒号：代表的是前后之间的关系，冒号前面是属性的名称，后面是属性的值，这个值可以是基本数据类型，也可以是引用数据类型。
详细参考微博文章:
https://blog.csdn.net/oman001/article/details/79063278
2. 复制响应示例文档
{
"code": 200,
"message": "操作成功",
"data": ""
}
3. 粘贴在FeHelper编辑器中
4. 使用ApiPost编辑JSON格式数据:
1. Body页面选择：mulitipart/form-data类型
1. 编辑：参数名+参数值+类型+参数描述
5. 导出粘贴
{
"contactInfoId": "120",
"name": "李欢",
"company": "格力电器（武汉）有限公司",
"position": "项目管理员",
"lastLoginTime": "2022-05-24 07:06:00",
"verificationMessage": "Hi，我是李欢，很高兴认识您",
"sendFromMeStatus": "是"
}
6. 复制到工具中进行快速编辑
7. 将编辑好的参数复制到返回示例中
复制 粘贴
8. 隐藏参数，便于后续进行修改再调出
好文推荐
您阅读本篇文章共花了：
发表评论