この記事では主にlaravelをベースにしたAPPインターフェース(API)の作成に関する関連情報を紹介します。必要な方は参考にしてください。お役に立てれば幸いです。
事前準備
前書き、その理由とやるべきこと
私の姓は Bai で、プログラミングに関しては全くの初心者ですが、大学 1 年生の時からプログラミングの素晴らしさに触れてきました。プログラミングの世界に完全に浸っています。
いえ、最近APPをいじるようになりました。今ではJavaScriptとちょっとしたHTML+CSSの技術だけでアプリの開発が完成すると言われています。ただし、APP のバックエンドは異なります。 APP を開発した後、それにデータを読み込みたい場合は、バックエンドを開発する必要があります。
laravel フレームワークは、間違いなく私のお気に入りの PHP フレームワークです。去年、laravel を使って個人の Web サイトを作成しましたが、その粗さに赤面してしまいました。詳細には触れずに、本題に直接進みましょう。まず、laravel をインストールします。
基本的な環境設定
具体的な手順については、Laravel5.2のインストールを直接参照してください
私の環境はwin10にwampsrver2.5をインストールしていますが、使用する場合は注意してください。 wampsrver2.5 では、これらの場所を変更する必要があります。これについては、私のメモを参照し、クリックしてプレビューしてください
ツール: sublime
ブラウザ: chrome (使用するプラグイン postman)
API について
API (Application Programming Interface、アプリケーション プログラミング インターフェイス) は、いくつかのプレ-define 関数の目的は、ソース コードにアクセスしたり、内部動作の詳細を理解したりすることなく、ソフトウェアまたはハードウェアに基づく一連のルーチンにアクセスできる機能をアプリケーションと開発者に提供することです。
API には特定の目的があり、それが何をするのかを知る必要があることに注意してください。 API にアクセスするときに入力する必要があるもの。 API にアクセスした後に何を取得する必要がありますか。
APIの設計を始める際に注意すべき8つのポイント
ここでの内容はマスターのブログからの抜粋です
その後の開発計画はこれを中心に展開していきます。 (本当に素晴らしい要約です)
1. 安心設計の原則
2. API の名前付け
3. API のセキュリティ
5. 画像処理
6. 返されるプロンプト情報
7. オンライン API テスト ドキュメント
8.アプリが起動し、初期化APIを呼び出して必要な情報を取得します
laravelでAPIを開発
まず、正しくダウンロードする必要があります
新しくインストールしたlaravelcomposer.jsonに以下の内容を追加します
composer update
App\Providers\OAuthServiceProvider::class, Dingo\Api\Provider\LaravelServiceProvider::class, LucaDegasperi\OAuth2Server\Storage\FluentStorageServiceProvider::class, LucaDegasperi\OAuth2Server\OAuth2ServerServiceProvider::class,
'Authorizer' => LucaDegasperi\OAuth2Server\Facades\Authorizer::class,
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
API_SUBTYPE=rest
API_NAME= RES T
API_PREFIX=api
API_VERSION=v1
API_CONDITIONAL_REQUEST=true
API_STRICT=false
API_DEBUG=true
API_DEFAULT_FORMAT=json
'grant_types' => [ 'password' => [ 'class' => 'League\OAuth2\Server\Grant\PasswordGrant', 'access_token_ttl' => 604800, 'callback' => '\App\Http\Controllers\Auth\PasswordGrantVerifier@verify', ], ],
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() { // } }
//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 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()); } }
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; } }
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');
関連する推奨事項:
以上がlaravelでAPPインターフェース(API)を書くの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。