专栏首页cwl_Java快速学习-接口文档

快速学习-接口文档

六、接口文档

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);

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • 3分钟快速阅读-《Effective Java》(二)

    cwl_java
  • 经典笔试篇-EJB及Spring篇

    162、EJB 与JAVA BEAN 的区别?【基础】 答:Java Bean 是可复用的组件,对Java Bean 并没有严格的规范,理论上讲,任何一个Ja...

    cwl_java
  • JDK1.9-常用函数式接口

    版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。

    cwl_java
  • 深入理解设计模式六大原则

    万变不离其宗,不管是Java还是C++,凡是面向对象的编程语言,在设计上,尽管表现形式可能有所不同,但是其实质和所需遵守的原则都是一致的。本文便是带领读者去深入...

    王金龙
  • app端接口用例设计方法和测试方法(一)

    接口测试用例结构要符合实际请求和下发的数据结构,这样方便了解数据结构特点,快速掌握接口数据含义,熟悉接口业务。先介绍请求数据的用例结构

    用户5521279
  • Android – Mac终端安装APK

    code_horse
  • Python模块

    简介: 模块:用一坨代码实现了某个功能的代码集合。分为三种: 自定义模块 第三方模块 内置模块 python去找模块的路径 ? 其中,第三方模块安装的位置 ? ...

    用户1173509
  • 你们要的动图来了:2张动图快速理解高内聚与低耦合

    模块就是从逻辑上将系统分解为更细微的部分, 分而治之, 复杂问题拆解为若干简单问题, 逐个解决.

    java进阶架构师
  • 图解高内聚与低耦合

    模块就是从逻辑上将系统分解为更细微的部分, 分而治之, 复杂问题拆解为若干简单问题, 逐个解决.

    用户1216491
  • 图解高内聚与低耦合,傻瓜都能看懂!

    模块就是从逻辑上将系统分解为更细微的部分, 分而治之, 复杂问题拆解为若干简单问题, 逐个解决.

    Java技术栈

扫码关注云+社区

领取腾讯云代金券