如何基于 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.pswp.cn/news/395737.shtml
繁體地址,請注明出處:http://hk.pswp.cn/news/395737.shtml
英文地址,請注明出處:http://en.pswp.cn/news/395737.shtml

如若內容造成侵權/違法違規/事實不符,請聯系多彩編程網進行投訴反饋email:809451989@qq.com,一經查實,立即刪除!

相關文章

mysql 基于集_一種基于記錄集查找特定行的方法_MySQL

問&#xff1a;我的一個表中包含了名為IdValue的單列主鍵。對于給定的IdValue值&#xff0c;我希望找到緊鄰目標值之前和之后的表行(假定結果按IdValue排序)。怎樣才能不使用游標而通過一個基于集合的方法得到需要的結果&#xff1f;答&#xff1a;Transact-SQL是一個基于集合的…

react 交互_如何在React中建立動畫微交互

react 交互Microinteractions guide a user through your application. They reinforce your user experience and provide delight.微交互引導用戶完成您的應用程序。 它們可以增強您的用戶體驗并帶來愉悅感。 You may have seen some of the slick examples of microinterac…

HTTPS與MITM

HTTPS:基于SSL/TSL的HTTP協議 MITM:Man-In-The-Middle中間人攻擊 Https下中間人攻擊的思路&#xff1a; 1 去https化 2 向CA申請相似域名的證書 防范&#xff1a; 睜大雙眼轉載于:https://www.cnblogs.com/the-owl/p/5596254.html

PCB genesis自制孔點 Font字體實現方法

一.先看genesis原有Font字體 在PCB工程CAM加孔點字體要求時,通常我們直接用Geneis軟件給我們提供了2種孔點字體canned_57與canned_67,但此字體可能不能滿足各個工廠個性化需求&#xff0c;比如&#xff1a;孔密度&#xff0c;孔間距&#xff0c;孔形狀分布&#xff0c;如果有一…

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

轉自&#xff1a;http://www.cnblogs.com/pied/p/5771782.html 就是看到篇報道&#xff0c;有點好奇&#xff0c;就去FQ挖了點東西回來。 我似乎已開始就抓到了重點&#xff0c;沒錯&#xff0c;就是 LK 。 LK 是 Travis Geiselbrecht 寫的一個針對 ARM 的嵌入式操作系統&#…

java 03_Java基礎03—流程控制

流程控制參考資料&#xff1a;《Java從入門到精通》/明日科技編著. 4版. 北京&#xff1a;清華大學出版社&#xff0c;2016一、復合語句Java的復合語句由“{”開始&#xff0c;“}”結束&#xff0c;又稱為塊語句。復合語句都是由上至下被執行&#xff1b;復合語句中可以嵌套復…

這三種策略可以幫助女性在科技領域蓬勃發展

by Shubhi Asthana通過Shubhi Asthana 這三種策略可以幫助女性在科技領域蓬勃發展 (These 3 strategies can help women thrive in tech) As someone early on in her career, I’ve attended a few tech talks, conferences, and meetups. One thing I noticed is not many w…

手機衛士09_應用程序四種查看_ListView小標題_進程管理

手機衛士09_應用程序四種查看_ListView小標題_進程管理 1.懸浮窗體的功能實現: 1.1.應用程序的卸載: 包安裝器 packageInstall,包卸載packageruninstall intent.setData(Uri.pare(“package:” 應用程序包名)) 卸載完之后記得更新list集合,更新適配器. 但是不確定用戶是否點了…

pandas:根據行間差值進行數據合并

1. 問題描述 在處理用戶上網數據時&#xff0c;用戶的上網行為數據之間存在時間間隔&#xff0c;按照實際情況&#xff0c;若時間間隔小于閾值&#xff08;next_access_time_app&#xff09;&#xff0c;則可把這幾條上網行為合并為一條行為數據&#xff1b;若時間間隔大于閾值…

Flask學習 一 基本結構

-from flask import Flaskfrom flask import Flask,render_template-from flask import request-from flask import make_response-from flask import abort-from flask import redirect-# __name__參數決定程序的根目錄app Flask (__name__)-# app.route (/)-# def hello_wor…

java8的路徑_什么是路徑?

# 什么是路徑&#xff1f;文件系統以某種形式的媒體(通常為一個或多個硬盤驅動器)存儲和組織文件&#xff0c;使得它們可以容易地被檢索。目前使用的大多數文件系統將文件存儲在樹形(或分層)結構中。在樹的頂部是一個(或多個)根節點。在根節點下&#xff0c;有文件和目錄(Micro…

為什么toString方法可以用來區分數組和對象?

首先大家都應該知道在javascript中只有是對象都存在toString方法&#xff0c;將調用該方法的值轉換為字符串返回&#xff0c;如下&#xff1a; var arr [1, 2, 3];console.log(arr.toString()); //1,2,3 但對象的toString方法和其他優點不同&#xff0c;其返回的是類似 [objec…

平安 開源 數據庫 實踐_刻意的實踐-成為開源

平安 開源 數據庫 實踐by Anthony Ng由Anthony Ng 刻意的實踐-成為開源 (Deliberate Practice — Becoming an Open Sourcerer) I recently finished reading Cal Newport’s book, So Good They Can’t Ignore You. It’s a quick read, and it introduced me to the concept…

更新Composer依賴報錯處理Fatal error: Declaration of Fxp\Composer\AssetPlugin\Repository\AbstractAssetsRe...

更新Composer依賴報錯處理 Fatal error: Declaration of Fxp\Composer\AssetPlugin\Repository\AbstractAssetsRepository::search() must be compatible with Composer\Repository\RepositoryInterface::search($query, $mode 0, $type NULL) in C:\Users\Arthur\AppData\Ro…

解析su,su -,sudo的區別

2019獨角獸企業重金招聘Python工程師標準>>> 本人以前一直習慣直接使用root&#xff0c;很少使用su&#xff0c;前幾天才發現su與su -命令是有著本質區別的&#xff01; 大部分Linux發行版的默認賬戶是普通用戶&#xff0c;而更改系統文件或者執行某些命令&#xff…

java 前置通知_spring aop中的前置通知

fixassetServicemyInterceptormyInterceptor2在上面的配置文件中 我配置了兩個interceptor &#xff0c;這兩個interceptor的invoke方法中的邏輯是一樣的。public Object invoke(MethodInvocation invo) throws Throwable {//自己的橫切邏輯log....invo.proceed()}我想請教的問…

Java并發編程藝術讀書筆記

1、多線程在CPU切換過程中&#xff0c;由于需要保存線程之前狀態和加載新線程狀態&#xff0c;成為上下文切換&#xff0c;上下文切換會造成消耗系統內存。所以&#xff0c;可合理控制線程數量。 如何控制&#xff1a; &#xff08;1&#xff09;使用ps -ef|grep appname&#…

您可能不需要翻譯您JavaScript

by Alex Ewerlf由AlexEwerlf 您可能不需要翻譯您JavaScript (You might not need to transpile your JavaScript) Popular guides like YouMightNotNeedJQuery.com and You Don’t Need Lodash/Underscore have challenged common industry practices.諸如YouMightNotNeedJQue…

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 & 清理并…

手機h5 java平臺_H5 手機 App 開發入門:技術篇

1、手機 App 的技術棧手機 App 的技術棧可以分成三類原生 App 技術棧原生技術棧指的是&#xff0c;只能用于特定手機平臺的開發技術。比如&#xff0c;安卓平臺的 Java 技術棧&#xff0c;iOS 平臺的 Object-C 技術棧或 Swift 技術棧。混合 App 技術棧混合技術棧指的是開發混合…