laravelをベースにしたAPIインターフェースの作成

laravelをベースにしたAPIインターフェースの作成

APIについて

##API(Application Programming Interface、アプリケーションプログラミングインターフェース)とは、あらかじめ定義されているものです。この関数の目的は、ソース コードにアクセスしたり、内部動作の詳細を理解したりすることなく、ソフトウェアまたはハードウェアに基づく一連のルーチンにアクセスできる機能をアプリケーションや開発者に提供することです。

API には特定の目的があり、それが何をするのかを知る必要があることに注意してください。 API にアクセスするときに入力する必要があるもの。 API にアクセスした後に何を取得する必要がありますか。

API の設計を開始するときは、次の 8 つのポイントに注意する必要があります。

その後の開発計画はこれを中心に展開します。

1.安静な設計原則

2.API 命名法
3.API セキュリティ
4.API 戻りデータ
5.画像処理
6.リターン プロンプト情報
7. オンライン API テストドキュメント
8. アプリ起動時に初期化 API を呼び出して必要な情報を取得

#laravel で API を開発

ゼロから勉強しようか悩んでいたときに、このプラグイン dingo/api を見つけたので、早速インストールしてみます！

まず、正しくダウンロードする必要があります。

新しくインストールしたlaravel combos.jsonに次の内容を追加します。

次に、cmdを開いて、

composer update

#を実行します。 ## config/app.php のプロバイダーに

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

を追加し、アプリを変更するためのエイリアスに

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

を追加します/ 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 職人ベンダー:パブリッシュ php 職人移行

これらの設定を .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',
  ],
],

新しいサービス プロバイダーを作成します。次の内容を含む新しい OAuthServiceProvider.php ファイルを app/Providers の下に作成します。

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="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 テーブルを開き、クライアント データを追加します

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 は次のとおりです。Add新しいユーザー

http: //localhost/register

すべてのユーザー情報を読み取ります

http://localhost/api/users

ユーザー ID 4

http://localhost/api/users/4

Get access_token

#http://localhost/oauth/access_token

## の情報#トークン値を使用して時刻を取得します。トークン値は正しいです。正しい値を返すには

#http://localhost/api/time

Open PostMan

laravel フレームワークの技術記事については、laravelチュートリアルをご覧ください。

以上がlaravelをベースにしたAPIインターフェースの作成の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。