基于laravel制作API介面

基于laravel制作API介面

關于API

API（Application Programming Interface,應用程式編程介面）是一些預先定義的函式，目的是提供應用程式與開發人員基于某軟體或硬體得以訪問一組例程的能力，而又無需訪問原始碼，或理解內部作業機制的細節，
需要注意的是：API有它的具體用途，我們應該清楚它是干啥的，訪問API的時候應該輸入什么，訪問過API過后應該得到什么，
在開始設計API時，我們應該注意這8點
后續的開發計劃就圍繞著這個進行了，
1.Restful設計原則
2.API的命名
3.API的安全性
4.API回傳資料
5.圖片的處理
6.回傳的提示資訊
7.在線API測驗檔案
8.在app啟動時，呼叫一個初始化API獲取必要的資訊

用laravel開發API

就在我上愁著要不要從零開始學習的時候，找到了這個插件dingo/api那么現在就來安裝吧！
首先一定是下載的沒錯
在新安裝好的laravel的composer.json加入如下內容
然后打開cmd執行
composer update
在config/app.php中的providers里添加

App\Providers\OAuthServiceProvider::class,
Dingo\Api\Provider\LaravelServiceProvider::class,
LucaDegasperi\OAuth2Server\Storage\FluentStorageServiceProvider::class,
LucaDegasperi\OAuth2Server\OAuth2ServerServiceProvider::class, 

在aliases里添加

'Authorizer' => LucaDegasperi\OAuth2Server\Facades\Authorizer::class,

修改app/Http/Kernel.php檔案里的內容

protected $middleware = [\LucaDegasperi\OAuth2Server\Middleware\OAuthExceptionHandlerMiddleware::class,
];
protected $routeMiddleware = [
 'oauth' => \LucaDegasperi\OAuth2Server\Middleware\OAuthMiddleware::class,
 'oauth-user' => \LucaDegasperi\OAuth2Server\Middleware\OAuthUserOwnerMiddleware::class,
 'oauth-client' => \LucaDegasperi\OAuth2Server\Middleware\OAuthClientOwnerMiddleware::class,
 'check-authorization-params' => \LucaDegasperi\OAuth2Server\Middleware\CheckAuthCodeRequestMiddleware::class,
 'csrf' => \App\Http\Middleware\VerifyCsrfToken::class,
];

然后執行

php artisan vendor:publish

php artisan migrate

在.env檔案里添加這些配置

API_STANDARDS_TREE=x
API_SUBTYPE=rest
API_NAME=REST
API_PREFIX=api
API_VERSION=v1
API_CONDITIONAL_REQUEST=true
API_STRICT=false
API_DEBUG=true
API_DEFAULT_FORMAT=json

修改app\config\oauth2.php檔案

'grant_types' => [
 'password' => [
 'class' => 'League\OAuth2\Server\Grant\PasswordGrant',
 'access_token_ttl' => 604800,
 'callback' => '\App\Http\Controllers\Auth\PasswordGrantVerifier@verify',
 ],
],

新建一個服務提供者，在app/Providers下新建OAuthServiceProvider.php檔案內容如下

namespace App\Providers;
  
use Dingo\Api\Auth\Auth;
use Dingo\Api\Auth\Provider\OAuth2;
use Illuminate\Support\ServiceProvider;
  
class OAuthServiceProvider extends ServiceProvider
{
 public function boot()
 {
 $this->app[Auth::class]->extend('oauth', function ($app) {
 $provider = new OAuth2($app['oauth2-server.authorizer']->getChecker());
  
 $provider->setUserResolver(function ($id) {
 // Logic to return a user by their ID.
 });
  
 $provider->setClientResolver(function ($id) {
 // Logic to return a client by their ID.
 });
  
 return $provider;
 });
 }
  
 public function register()
 {
 //
 }
}

然后打開routes.php添加相關路由

//Get access_token
Route::post('oauth/access_token', function() {
 return Response::json(Authorizer::issueAccessToken());
});
  
//Create a test user, you don't need this if you already have.
Route::get('/register',function(){
 $user = new App\User();
 $user->name="tester";
 $user->email="[email protected]";
 $user->password = \Illuminate\Support\Facades\Hash::make("password");
 $user->save();
});
$api = app('Dingo\Api\Routing\Router');
  
//Show user info via restful service.
$api->version('v1', ['namespace' => 'App\Http\Controllers'], function ($api) {
 $api->get('users', 'UsersController@index');
 $api->get('users/{id}', 'UsersController@show');
});
  
//Just a test with auth check.
$api->version('v1', ['middleware' => 'api.auth'] , function ($api) {
 $api->get('time', function () {
 return ['now' => microtime(), 'date' => date('Y-M-D',time())];
 });
});

分別創建BaseController.php和UsersController.php內容如下

//BaseController
namespace App\Http\Controllers;
  
use Dingo\Api\Routing\Helpers;
use Illuminate\Routing\Controller;
  
class BaseController extends Controller
{
 use Helpers;
}
  
//UsersController
namespace App\Http\Controllers;
  
use App\User;
use App\Http\Controllers\Controller;
  
class UsersController extends BaseController
{
  
 public function index()
 {
 return User::all();
 }
  
 public function show($id)
 {
 $user = User::findOrFail($id);
 // 陣列形式
 return $this->response->array($user->toArray());
 }

}

隨后在app/Http/Controllers/Auth/下創建PasswordGrantVerifier.php內容如下

namespace App\Http\Controllers\Auth;
use Illuminate\Support\Facades\Auth;
  
class PasswordGrantVerifier
{
 public function verify($username, $password)
 {
 $credentials = [
 'email' => $username,
 'password' => $password,
 ];
  
 if (Auth::once($credentials)) {
 return Auth::user()->id;
 }
  
 return false;
 }
}

打開資料庫的oauth_client表新增一條client資料

INSERT INTO 'oauth_clients' ('id', 'secret', 'name', 'created_at', 'updated_at') VALUES ('1', '2', 'Main website', '2016–03–13 23:00:00', '0000–00–00 00:00:00');

隨后的就是去愉快的測驗了，這里要測驗的API有

新增一個用戶

http://localhost/register

讀取所有用戶資訊

http://localhost/api/users

只回傳用戶id為4的資訊

http://localhost/api/users/4

獲取access_token

http://localhost/oauth/access_token

利用token值獲得時間，token值正確才能回傳正確值

http://localhost/api/time

打開PostMan

更多PHP內容請訪問：

騰訊T3-T4標準精品PHP架構師教程目錄大全，只要你看完保證薪資上升一個臺階（持續更新）

標籤：PHP

上一篇：遇到snprintf() 疑惑！

下一篇：php 回圈【轉】