如何基于 Notadd 构建 API （Laravel 写 API）

如何基于 Notadd 构建 API

Notadd 底层实现了 passport 机制，有统一的授权管理，主要支持两种方式进行 API 授权，一个是 client，领一个是 passport，这个在其他文档中有做详细的说明。

这里主要说的是，如何基于 Notadd 进行 API 接口的开发。

业务逻辑

熟悉 Laravel 的同学都应该知道，Laravel 遵循这样的业务逻辑实现：

路由(route) -> 控制器(controller) -> 业务逻辑(model) -> 数据输出(view)

而 Notadd 的 API 业务逻辑实现同样遵循类似的流程：

路由(route) -> 控制器(controller) -> API 处理器(handler) -> 模型(model) -> 数据输出(json)

其中，主要的差异在于，API 处理器提供了对数据输出格式的输出，返回的数据格式统一为：

['code' => 200,             // API 接口返回的状态码，默认为 200'data' => [],              // API 接口返回的数据，主要为数组形式'message' => 'success！',  // API 接口返回的提示信息，可以包含错误信息或成功信息
]

路由

Notadd 在实现 API 授权的时候，使用的是有 路由中间件(middleware) 的方式来实现的。

具体实现方式，是在路由的中间配置参数中添加 auth:api 。

例如，在实现 api/setting/all 和 api/setting/set 两个 API 的时候，添加 auth:api 的中间件，代码参考如下：

$this->router->group(['middleware' => ['auth:api', 'web'], 'prefix' => 'api/setting'], function () {$this->router->post('all', 'Notadd\Foundation\Setting\Controllers\SettingController@all');$this->router->post('set', 'Notadd\Foundation\Setting\Controllers\SettingController@set');
});

Notadd 针对需要跨域的 API 还提供了 cross 的路由中间件，以实现 API 跨域的功能。

例如，为前两个 API 提供跨域的功能实现，代码参考如下：

$this->router->group(['middleware' => ['auth:api', 'cross', 'web'], 'prefix' => 'api/setting'], function () {$this->router->post('all', 'Notadd\Foundation\Setting\Controllers\SettingController@all');$this->router->post('set', 'Notadd\Foundation\Setting\Controllers\SettingController@set');
});

控制器

由于有了独立的 API处理器 ，控制器层可以制作简单处理，仅需向控制器注入 handler，并由 handler 提供的辅助方法返回 API 数据给前台，即可。

例如，在前面路由调用的 SettingController 中，仅需要注入 AllHandler ，使用方法 toResponse 和 generateHttpResponse 来返回结果给前台，代码参考如下：

<?php
/*** This file is part of Notadd.** @author TwilRoad <269044570@qq.com>* @copyright (c) 2016, iBenchu.org* @datetime 2016-11-08 17:01*/
namespace Notadd\Foundation\Setting\Controllers;use Notadd\Foundation\Routing\Abstracts\Controller;
use Notadd\Foundation\Setting\Contracts\SettingsRepository;
use Notadd\Foundation\Setting\Handlers\AllHandler;
use Notadd\Foundation\Setting\Handlers\SetHandler;/*** Class SettingController.*/
class SettingController extends Controller
{/*** @var \Notadd\Foundation\Setting\Contracts\SettingsRepository*/protected $settings;/*** SettingController constructor.** @param \Notadd\Foundation\Setting\Contracts\SettingsRepository $settings** @throws \Illuminate\Contracts\Container\BindingResolutionException*/public function __construct(SettingsRepository $settings){parent::__construct();$this->settings = $settings;}/*** All handler.** @param \Notadd\Foundation\Setting\Handlers\AllHandler $handler** @return \Notadd\Foundation\Passport\Responses\ApiResponse* @throws \Exception*/public function all(AllHandler $handler){return $handler->toResponse()->generateHttpResponse();}/*** Set handler.** @param \Notadd\Foundation\Setting\Handlers\SetHandler $handler** @return \Notadd\Foundation\Passport\Responses\ApiResponse* @throws \Exception*/public function set(SetHandler $handler){return $handler->toResponse()->generateHttpResponse();}
}

API Handler 和模型

在 API Handler中提供了模型的操作接口。

在 Notadd 中，提供了两类 API Handler，一类是 DataHandler，另一类是 SetHandler，顾名思义，DataHandler 仅提供数据返回接口，而 SetHandler 不仅提供数据返回接口，还提供其他操作处理的接口。

具体差异体现在，DataHandler 在返回数据接口时仅调用方法 data，而 SetHandler 在调用 data 方法前还有调用 execute 方法。

例如，在前面的 SettingController 中使用的 AllHandler 为 DataHandler 类 Handler，提供返回所有 配置项 的 API 功能，SetHandler 为 SetHandler 类 Handler，提供 修改配置项 并返回所有 配置项 的 API 功能。

AllHandler 的代码如下：

<?php
/*** This file is part of Notadd.** @author TwilRoad <269044570@qq.com>* @copyright (c) 2016, iBenchu.org* @datetime 2016-11-23 14:44*/
namespace Notadd\Foundation\Setting\Handlers;use Illuminate\Container\Container;
use Notadd\Foundation\Passport\Abstracts\DataHandler;
use Notadd\Foundation\Setting\Contracts\SettingsRepository;/*** Class AllHandler.*/
class AllHandler extends DataHandler
{/*** @var \Notadd\Foundation\Setting\Contracts\SettingsRepository*/protected $settings;/*** AllHandler constructor.** @param \Illuminate\Container\Container                         $container* @param \Notadd\Foundation\Setting\Contracts\SettingsRepository $settings*/public function __construct(Container $container,SettingsRepository $settings) {parent::__construct($container);$this->settings = $settings;}/*** Http code.** @return int*/public function code()                                                 // 定义 API 操作结果的状态码{return 200;}/*** Data for handler.** @return array*/public function data()                                                  // 定义 API 返回的数据{return $this->settings->all()->toArray();}/*** Errors for handler.** @return array*/public function errors()                                                // 定义 API 操作失败时返回的信息{return ['获取全局设置失败！',];}/*** Messages for handler.** @return array*/public function messages()                                             // 定义 API 操作成功时返回的信息{return ['获取全局设置成功！',];}
}

SetHandler 的代码如下：

<?php
/*** This file is part of Notadd.** @author TwilRoad <269044570@qq.com>* @copyright (c) 2016, iBenchu.org* @datetime 2016-11-23 15:09*/
namespace Notadd\Foundation\Setting\Handlers;use Illuminate\Container\Container;
use Notadd\Foundation\Passport\Abstracts\SetHandler as AbstractSetHandler;
use Notadd\Foundation\Setting\Contracts\SettingsRepository;/*** Class SetHandler.*/
class SetHandler extends AbstractSetHandler
{/*** @var \Notadd\Foundation\Setting\Contracts\SettingsRepository*/protected $settings;/*** SetHandler constructor.** @param \Illuminate\Container\Container                         $container* @param \Notadd\Foundation\Setting\Contracts\SettingsRepository $settings*/public function __construct(Container $container,SettingsRepository $settings) {parent::__construct($container);$this->settings = $settings;}/*** Data for handler.** @return array*/public function data()                                                                    // 定义 API 返回的数据{return $this->settings->all()->toArray();}/*** Errors for handler.** @return array*/public function errors()                                                                  // 定义 API 操作失败时返回的信息{return ['修改设置失败！',];}/*** Execute Handler.** @return bool*/public function execute()                                                                 // 定义 API 执行的修改操作{$this->settings->set('site.enabled', $this->request->input('enabled'));$this->settings->set('site.name', $this->request->input('name'));$this->settings->set('site.domain', $this->request->input('domain'));$this->settings->set('site.beian', $this->request->input('beian'));$this->settings->set('site.company', $this->request->input('company'));$this->settings->set('site.copyright', $this->request->input('copyright'));$this->settings->set('site.statistics', $this->request->input('statistics'));return true;}/*** Messages for handler.** @return array*/public function messages()                                                                // 定义 API 操作成功时返回的信息{return ['修改设置成功!',];}
}

数据输出

API 结果的数据输出，已经在 控制器(controller) 中做了处理。

至此，一个完整的 API 开发完成。

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/news/395737.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

PCB genesis自制孔点 Font字体实现方法

PCB genesis自制孔点 Font字体实现方法

一.先看genesis原有Font字体 在PCB工程CAM加孔点字体要求时,通常我们直接用Geneis软件给我们提供了2种孔点字体canned_57与canned_67,但此字体可能不能满足各个工厂个性化需求&#xff0c;比如&#xff1a;孔密度&#xff0c;孔间距&#xff0c;孔形状分布&#xff0c;如果有一…
阅读更多...
Google 最新的 Fuchsia OS【科技讯息摘要】

Google 最新的 Fuchsia OS【科技讯息摘要】

转自&#xff1a;http://www.cnblogs.com/pied/p/5771782.html 就是看到篇报道&#xff0c;有点好奇&#xff0c;就去FQ挖了点东西回来。 我似乎已开始就抓到了重点&#xff0c;没错&#xff0c;就是 LK 。 LK 是 Travis Geiselbrecht 写的一个针对 ARM 的嵌入式操作系统&#…
阅读更多...
pandas：根据行间差值进行数据合并

pandas：根据行间差值进行数据合并

1. 问题描述 在处理用户上网数据时&#xff0c;用户的上网行为数据之间存在时间间隔&#xff0c;按照实际情况&#xff0c;若时间间隔小于阈值&#xff08;next_access_time_app&#xff09;&#xff0c;则可把这几条上网行为合并为一条行为数据&#xff1b;若时间间隔大于阈值…
阅读更多...
java8的路径_什么是路径？

java8的路径_什么是路径？

# 什么是路径&#xff1f;文件系统以某种形式的媒体(通常为一个或多个硬盘驱动器)存储和组织文件&#xff0c;使得它们可以容易地被检索。目前使用的大多数文件系统将文件存储在树形(或分层)结构中。在树的顶部是一个(或多个)根节点。在根节点下&#xff0c;有文件和目录(Micro…
阅读更多...
解析su,su -,sudo的区别

解析su,su -,sudo的区别

2019独角兽企业重金招聘Python工程师标准>>> 本人以前一直习惯直接使用root&#xff0c;很少使用su&#xff0c;前几天才发现su与su -命令是有着本质区别的&#xff01; 大部分Linux发行版的默认账户是普通用户&#xff0c;而更改系统文件或者执行某些命令&#xff…
阅读更多...
java maven 操作 收集的一些命令

java maven 操作 收集的一些命令

maven打包&#xff1a; mvn clean package -Dmaven.test.skiptrue 运行jar: java -jar target/spring-boot-scheduler-1.0.0.jar 这种方式关掉控制台就不可以访问&#xff0c;现在要后台运行的方式启动 nohup java -jar target/spring-boot-scheduler-1.0.0.jar & 清理并…
阅读更多...
java犯的小错误_[Java教程]十个JavaScript中易犯的小错误，你中了几枪？

java犯的小错误_[Java教程]十个JavaScript中易犯的小错误，你中了几枪？

[Java教程]十个JavaScript中易犯的小错误&#xff0c;你中了几枪&#xff1f;0 2015-06-01 12:00:19序言在今天&#xff0c;JavaScript已经成为了网页编辑的核心。尤其是过去的几年&#xff0c;互联网见证了在SPA开发、图形处理、交互等方面大量JS库的出现。如果初次打交道&…
阅读更多...
Kali渗透测试——利用metasploit攻击靶机WinXP SP1

Kali渗透测试——利用metasploit攻击靶机WinXP SP1

搭建渗透测试环境 Kali攻击机 WinXP SP1 靶机 启动metasploit 跟windows RPC相关的漏洞 内部提供的漏洞攻击 靶机winxp sp1网络配置 查看虚拟机的NAT网段 配置WinXP SP1靶机的IP地址 执行漏洞利用 后漏洞利用&#xff1a;meterpreter> 靶机的信息 进程情况 查看到explorer.e…
阅读更多...
创建响应式布局的优秀网格工具集锦《系列五》

创建响应式布局的优秀网格工具集锦《系列五》

在这篇文章中&#xff0c;我们为您呈现了一组优秀的网格工具清单。如果网页设计和开人员采用了正确的工具集&#xff0c;并基于一个灵活的网格架构&#xff0c;以及能够把响应图像应用到到设计之中&#xff0c;那么创建一个具备响应式的网站并不一定是一项艰巨的任务。enjoy! 您…
阅读更多...
java 无侵入监控_MyPerf4J 一个高性能、无侵入的Java性能监控和统计工具

java 无侵入监控_MyPerf4J 一个高性能、无侵入的Java性能监控和统计工具

MyPerf4J一个针对高并发、低延迟应用设计的高性能且无侵入的实时Java性能监控和统计工具。 受 perf4j 和 TProfiler启发而来。MyPerf4J具有以下几个特性&#xff1a;无侵入: 采用JavaAgent方式&#xff0c;对应用程序完全无侵入&#xff0c;无需修改应用代码高性能: 性能消耗非…
阅读更多...
javascript 减少回流

javascript 减少回流

减少回流&#xff08;REFLOWS&#xff09; 当浏览器重新渲染文档中的元素时需要 重新计算它们的位置和几何形状&#xff0c;我们称之为回流。回流会阻塞用户在浏览器中的操作&#xff0c;因此理解提升回流时间是非常有帮助的。 回流时间图表 你应该批量地触发回流或重绘&#x…
阅读更多...
转: 关于 ssl的建立链接的过程

转: 关于 ssl的建立链接的过程

转自&#xff1a; http://www.ruanyifeng.com/blog/2014/02/ssl_tls.html SSL/TLS协议运行机制的概述 作者&#xff1a; 阮一峰 日期&#xff1a; 2014年2月 5日 互联网的通信安全&#xff0c;建立在SSL/TLS协议之上。 本文简要介绍SSL/TLS协议的运行机制。文章的重点是设计思…
阅读更多...
PHP 文件加密Zend Guard Loader 学习和使用（如何安装ioncube扩展对PHP代码加密）

PHP 文件加密Zend Guard Loader 学习和使用（如何安装ioncube扩展对PHP代码加密）

一、大体流程图 二、PHP 项目文件加密 下表列出了Zend产品中的PHP版本及其内部API版本和Zend产品版本。 如何加密请往后看 三、如何使用 第一步&#xff1a;确认当前环境 Amai Phalcon 前&#xff0c;请确认您具备以下两个条件&#xff0c;如果您的环境不满足此条件&#xff0c…
阅读更多...
php寻找文本,PHP文本数据库的搜索方法_php

php寻找文本,PHP文本数据库的搜索方法_php

//php文本数据库的搜索方法searchstr("/".preg_quote($searchstr)."/");//$searchstr是查找的关键字$recordsfile($file);//获取所有的记录数http://www.gaodaima.com/45906.htmlPHP文本数据库的搜索方法_php//$file是查找的数据文件$search_reocrdspreg_g…
阅读更多...
bzoj 2178 圆的面积并 —— 辛普森积分

bzoj 2178 圆的面积并 —— 辛普森积分

题目&#xff1a;https://www.lydsy.com/JudgeOnline/problem.php?id2178 先看到这篇博客&#xff1a;https://www.cnblogs.com/heisenberg-/p/6740654.html 好像本应算弓形面积、三角形面积之类的&#xff0c;但不会...于是用辛普森积分硬做... 参考了这篇博客&#xff1a;ht…
阅读更多...
Charles抓包工具的使用

Charles抓包工具的使用

2019独角兽企业重金招聘Python工程师标准>>> 感谢唐巧分享的文章&#xff0c;受益匪浅 文章目录 1. 目录及更新说明2. Charles 限时优惠3. 简介4. 安装 Charles5. 将 Charles 设置成系统代理6. Charles 主界面介绍7. 过滤网络请求8. 截取 iPhone 上的网络封包 8.1. …
阅读更多...
iOS开发——处理1000张图片的内存优化

iOS开发——处理1000张图片的内存优化

一、项目需求 在实际项目中&#xff0c;用户在上传图片时&#xff0c;有时会一次性上传大量的图片。在上传图片前&#xff0c;我们要进行一系列操作&#xff0c;比如&#xff1a;旋转图片为正确方向&#xff0c;压缩图片等&#xff0c;这些操作需要将图片加载到内存中&#xff…
阅读更多...
jquery ui php,php – 打开带有动态内容的jQuery UI对话框

jquery ui php,php – 打开带有动态内容的jQuery UI对话框

我有一个关于jQuery UI对话框的问题,并显示数据库中的动态内容.所以我得到了一个web应用程序,我还需要创建一个管理模块来管理所有用户和其他信息.我创建了一个页面,显示列表中的所有用户,在每一行中我也创建了一个编辑按钮.我想这样做,当你按下用户的编辑按钮时,会打开一个对话…
阅读更多...
MapReduce Input Split 输入分/切片

MapReduce Input Split 输入分/切片

MapReduce Input Split&#xff08;输入分/切片&#xff09;详解 public static long getMaxSplitSize(JobContext context) { return context.getConfiguration().getLong(SPLIT_MAXSIZE, Long.MAX_VALUE); } 如果没有设置这maxsize默认是Long.MAX_VALUE public static long …
阅读更多...
WPF自定义空心文字

WPF自定义空心文字

WPF自定义空心文字 原文:WPF自定义空心文字首先创建一个自定义控件&#xff0c;继承自FrameworkElement&#xff0c;“Generic.xaml”中可以不添加样式。 要自定义空心文字&#xff0c;要用到绘制格式化文本FormattedText类。FormattedText对象提供的文本格式设置功能比WPF提供…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023