主頁 > 知識庫 > 詳解Laravel制作API接口

詳解Laravel制作API接口

熱門標(biāo)簽:銀行業(yè)務(wù) Linux服務(wù)器 阿里云 科大訊飛語音識別系統(tǒng) 電子圍欄 團(tuán)購網(wǎng)站 服務(wù)器配置 Mysql連接數(shù)設(shè)置

需要注意的是:API有它的具體用途,我們應(yīng)該清楚它是干啥的。訪問API的時(shí)候應(yīng)該輸入什么。訪問過API過后應(yīng)該得到什么。

在開始設(shè)計(jì)API時(shí),我們應(yīng)該注意這8點(diǎn)。后續(xù)的開發(fā)計(jì)劃就圍繞著這個(gè)進(jìn)行了。

1.Restful設(shè)計(jì)原則

2.API的命名

3.API的安全性

4.API返回?cái)?shù)據(jù)

5.圖片的處理

6.返回的提示信息

7.在線API測試文檔

8.在app啟動(dòng)時(shí),調(diào)用一個(gè)初始化API獲取必要的信息

用laravel開發(fā)API

就在我上愁著要不要從零開始學(xué)習(xí)的時(shí)候,找到了這個(gè)插件dingo/api那么現(xiàn)在就來安裝吧!

首先一定是下載的沒錯(cuò)

在新安裝好的laravel的composer.json加入如下內(nèi)容

然后打開cmd執(zhí)行

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文件里的內(nèi)容

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,
];

然后執(zhí)行

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',
 ],
],

新建一個(gè)服務(wù)提供者,在app/Providers下新建OAuthServiceProvider.php文件內(nèi)容如下

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添加相關(guān)路由

//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="test@test.com";
 $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())];
 });
});

分別創(chuàng)建BaseController.php和UsersController.php內(nèi)容如下

//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);
 // 數(shù)組形式
 return $this->response->array($user->toArray());
 }
}

隨后在app/Http/Controllers/Auth/下創(chuàng)建PasswordGrantVerifier.php內(nèi)容如下

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

打開數(shù)據(jù)庫的oauth_client表新增一條client數(shù)據(jù)

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有

新增一個(gè)用戶

http://localhost/register

讀取所有用戶信息

http://localhost/api/users

只返回用戶id為4的信息

http://localhost/api/users/4

獲取access_token

http://localhost/oauth/access_token

利用token值獲得時(shí)間,token值正確才能返回正確值

http://localhost/api/time

打開PostMan

以上就是詳解Laravel制作API接口的詳細(xì)內(nèi)容,更多關(guān)于Laravel制作API接口的資料請關(guān)注腳本之家其它相關(guān)文章!

您可能感興趣的文章:
  • Laravel如何實(shí)現(xiàn)適合Api的異常處理響應(yīng)格式
  • Laravel5.5+ 使用API Resources快速輸出自定義JSON方法詳解
  • laravel接管Dingo-api和默認(rèn)的錯(cuò)誤處理方式
  • 在Laravel中使用GuzzleHttp調(diào)用第三方服務(wù)的API接口代碼
  • Laravel實(shí)現(xiàn)ApiToken認(rèn)證請求
  • laravel框架 api自定義全局異常處理方法
  • laravel dingo API返回自定義錯(cuò)誤信息的實(shí)例
  • laravel 配置路由 api和web定義的路由的區(qū)別詳解
  • Laravel5.4簡單實(shí)現(xiàn)app接口Api Token認(rèn)證方法

標(biāo)簽:萍鄉(xiāng) 廣元 江蘇 蚌埠 大理 棗莊 衢州 衡水

巨人網(wǎng)絡(luò)通訊聲明:本文標(biāo)題《詳解Laravel制作API接口》,本文關(guān)鍵詞  ;如發(fā)現(xiàn)本文內(nèi)容存在版權(quán)問題,煩請?zhí)峁┫嚓P(guān)信息告之我們,我們將及時(shí)溝通與處理。本站內(nèi)容系統(tǒng)采集于網(wǎng)絡(luò),涉及言論、版權(quán)與本站無關(guān)。
  • 相關(guān)文章
  • 收縮
    • 微信客服
    • 微信二維碼
    • 電話咨詢

    • 400-1100-266