快速学习-接口文档

六、接口文档

1、接口内容

接口名称

场景说明

接口说明

请求参数

响应参数

错误码

2、请求参数内容

字段名 是否必填 类型 示例值 描述

3、响应参数内容

字段名称

描述

返回示例

4、错误码内容

名称 描述 原因 解决方案

5、示例

在这里插入图片描述

在这里插入图片描述

6、练习（接口文档）

将admin/controller/Goods.php中 save方法 改为 接口方式

① 将Base控制器中的登录验证，注释。

② 将save方法代码 复制到 save2方法

③将save2方法中的参数验证规则修改（删除 token规则， 添加 goods_logo字段的验证）

④将$this->error 和$this->success部分代码，修改为 return json（）这种代码。

⑤将文件上传的方法调用 注释

⑥通过postman测试save2接口

⑦ 写接口文档

7、练习（项目搭建）

1、安装部署tp框架（解压压缩包、配置虚拟站点）（主域名、子域名，比如 www.pyg.com 和 adminapi.pyg.com）

2、模块划分（后台模块admin、前台模块home、后台接口模块adminapi、公共模块common）

3、admin模块、home模块、adminapi模块 有默认的控制器方法，可以访问。 common模块下只需要model模型目录

4、路由配置： adminapi模块 配置域名路由

5、尝试，对adminapi模块，创建一个Base控制器，定义ok方法和fail方法，用于快捷返回结果数据

比如：

失败时，以下两行代码 效果一样
return json(['code' => 401, 'msg' => '参数错误', 'data' => []]);
//$this->fail(401, '参数错误');

成功时，以下两行代码 效果一样
return json(['code' => 200, 'msg' => 'success', 'data' => $data]);
//$this->ok($data);