Laravel如何制作API接口

這篇文章給大家分享的是有關Laravel如何制作API接口的內容。小編覺得挺實用的，因此分享給大家做個參考，一起跟隨小編過來看看吧。

需要注意的是：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\OAuth3Server\Storage\FluentStorageServiceProvider::class,

LucaDegasperi\OAuth3Server\OAuth3ServerServiceProvider::class,

在aliases里添加

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

修改app/Http/Kernel.php文件里的內容

protected $middleware = [\LucaDegasperi\OAuth3Server\Middleware\OAuthExceptionHandlerMiddleware::class,
];
protected $routeMiddleware = [
 'oauth' => \LucaDegasperi\OAuth3Server\Middleware\OAuthMiddleware::class,
 'oauth-user' => \LucaDegasperi\OAuth3Server\Middleware\OAuthUserOwnerMiddleware::class,
 'oauth-client' => \LucaDegasperi\OAuth3Server\Middleware\OAuthClientOwnerMiddleware::class,
 'check-authorization-params' => \LucaDegasperi\OAuth3Server\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\oauth3.php文件

'grant_types' => [
 'password' => [
 'class' => 'League\OAuth3\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\OAuth3;
use Illuminate\Support\ServiceProvider;
   
class OAuthServiceProvider extends ServiceProvider
{
 public function boot()
 {
 $this->app[Auth::class]->extend('oauth', function ($app) {
 $provider = new OAuth3($app['oauth3-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="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())];
 });
});

分別創建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

感謝各位的閱讀！關于“Laravel如何制作API接口”這篇文章就分享到這里了，希望以上內容可以對大家有一定的幫助，讓大家可以學到更多知識，如果覺得文章不錯，可以把它分享出去讓更多的人看到吧！