कोड की 100 लाइनों में Laravel पर REST API

inb4: डॉक्यूमेंट से कॉपी पेस्ट

गाइड एक जगह पर एकत्र किए गए लारवेल 5.7 प्रलेखन से लिया गया सबसे अच्छा अभ्यास के अनुसार पूर्ण विकसित एपीआई विकास के लिए न्यूनतम सेट की तेजी से तैनाती पर केंद्रित है। मैंने अपने और अपने सहयोगियों के लिए एक धोखा पत्र के रूप में लिखा, मुझे उम्मीद है कि यह किसी और के लिए उपयोगी होगा।

प्रीसेट

हमने एक ढांचा रखा

composer create-project --prefer-dist laravel/laravel scaffold-api

अनावश्यक UI घटक निकालें (vuejs, प्रतिक्रिया)

php artisan preset none

डेटाबेस कनेक्शन कॉन्फ़िगर करें

फ़ोल्डर पर जाएं, .env फ़ाइल संपादित करें:

 DB_CONNECTION=mysql DB_HOST=localhost DB_PORT=3306 DB_DATABASE=api-authentification DB_USERNAME=root DB_PASSWORD= 

उत्पादन शुरू हो रहा है

हम कंसोल में निष्पादित करते हैं
php artisan make:model Game -mrc

हमें मॉडल, माइग्रेशन और कंट्रोलर मिलता है:

 Model created successfully. Factory created successfully. Created Migration: 2019_02_27_105610_create_games_table Controller created successfully. 

डेटाबेस तालिका में कॉलम बनाएं

हम तालिका में कॉलम जोड़कर प्रवास को सही करते हैं। आमतौर पर इस्तेमाल किए जाने वाले प्रकार:

• increments('id')
• string('title')
• text('description')
• tinyInteger('complexity')
• boolean('isActive')
• softDeletes()

वैकल्पिक फ़ील्ड के लिए, ->default() साथ डिफ़ॉल्ट मान जोड़ना न भूलें

php artisan migrate करके पलायन लागू करें

हम सत्यापन नियम बनाते हैं

रनिंग php artisan make:request GameRequest

App/Http/Requests/GameRequest.php ।
authorize() विधि में, हम प्राधिकरण जोड़ने तक return true ।
rules() विधि में दी गई सारणी उन सभी स्तंभों के नियमों का वर्णन करती है जिन्हें हमने माइग्रेशन में सूचीबद्ध किया था। यहां उपलब्ध नियम

कोड को कम करने के लिए, हम अलग-अलग http क्रियाओं के लिए स्विच निर्माण का उपयोग करते हैं, बजाय अलग StoreGameRequest, UpdateGameRequest, आदि के।

 public function rules(Request $request) { $rules = [ 'title' => 'required|string|unique:games,title', 'description' => '', 'complexity' => 'required|min:1|max:10', 'minPlayers' => 'required|min:1|max:10', 'maxPlayers' => 'required|min:1|max:10', 'isActive' => 'required|boolean' ]; switch ($this->getMethod()) { case 'POST': return $rules; case 'PUT': return [ 'game_id' => 'required|integer|exists:games,id', // .   : unique:games,id,' . $this->route('game'), 'title' => [ 'required', Rule::unique('games')->ignore($this->title, 'title') //  ,     ] ] + $rules; //      // case 'PATCH': case 'DELETE': return [ 'game_id' => 'required|integer|exists:games,id' ]; } } 

कस्टम त्रुटि विवरण विकल्प

यदि आपको अपने स्वयं के त्रुटि ग्रंथों की आवश्यकता है, तो हम संदेशों () विधि को फिर से परिभाषित करते हैं, जो प्रत्येक नियम के अनुवाद के साथ एक सरणी देता है:

 public function messages() { return [ 'date.required' => 'A date is required', 'date.date_format' => 'A date must be in format: Ym-d', 'date.unique' => 'This date is already taken', 'date.after_or_equal' => 'A date must be after or equal today', 'date.exists' => 'This date doesn\'t exists', ]; } 

यह सुनिश्चित करने के लिए कि न केवल अनुरोध निकाय में पारित पैरामीटर, बल्कि URL में पारित किए गए पैरामीटर भी सत्यापन नियमों में उपलब्ध हैं, हम सभी विधि को पुनर्परिभाषित करते हैं (जो आमतौर पर $ अनुरोध के रूप में नियंत्रक में उपयोग किया जाता है-> सभी) ():

 public function all($keys = null) { // return $this->all(); $data = parent::all($keys); switch ($this->getMethod()) { // case 'PUT': // case 'PATCH': case 'DELETE': $data['date'] = $this->route('day'); } return $data; } 

हम नियंत्रक को कॉन्फ़िगर करते हैं और व्यापारिक तर्क का वर्णन करते हैं

Http\Controllers\GameController । हम रेंडर फॉर्म के लिए जेनरेट create(), edit() तरीके हटाते हैं (क्योंकि हमारे पास REST API है, उनकी जरूरत नहीं है)।

मानक use Illuminate\Http\Request; बदलें use Illuminate\Http\Request; हमारे use App\Http\Requests\GameRequest; पर, use App\Http\Requests\GameRequest;

अगला, विधियों को संपादित करें:

 public function index() { return Game::all(); } 

 public function store(GameRequest $request) { $day = Game::create($request->validated()); return $day; } 

 public function show(Game $game) { return $game = Game::findOrFail($game); } 

 public function update(GameRequest $request, $id) { $game = Game::findOrFail($id); $game->fill($request->except(['game_id'])); $game->save(); return response()->json($game); } 

 public function destroy(GameRequest $request, $id) { $game = Game::findOrFail($id); if($game->delete()) return response(null, 204); } 

यदि बहुत तर्क है, तो इसे एक अलग परत सेवा / रिपॉजिटरी में रखना बेहतर है

मॉडल को अनुकूलित करें

एप्लिकेशन खोलें / Http / Game.php मॉडल और गुण जोड़ें:

 protected $fillable = ['title', 'description', 'complexity', 'minPlayers', 'maxPlayers', 'isActive']; protected $hidden = ['created_at', 'updated_at', 'deleted_at']; 

मिडलवेयर कॉन्फ़िगर करें

ताकि हमारे आवेदन हमेशा हेडर पारित की परवाह किए बिना वापस लौट आए, हम मिडलवेयर बनाते हैं:

 php artisan make:middleware ForceJsonResponse 

और इसमें कोड जोड़ें:

 public function handle($request, Closure $next) { $request->headers->set('Accept', 'application/json'); return $next($request); } 

इस मिडलवेयर को app/Http/Kernel.php में पंजीकृत करें:

 ... 'api' => [ 'throttle:60,1', 'bindings', \App\Http\Middleware\ForceJsonResponse::class, ], 

हम रूटिंग को कॉन्फ़िगर करते हैं

खुले routes/api.php और जोड़ें:

 use Http\Controllers\GameController; Route::apiResource('/games', 'GameController'); 

स्थिर मार्ग :: apiResource विधि, संसाधन विधि के विपरीत, केवल अनुक्रमणिका, शो, स्टोर, अपडेट को नष्ट करने, नष्ट करने और संपादित करने के तरीकों को छोड़कर।

वही अधिक स्पष्ट रिकॉर्ड के साथ प्राप्त किया जा सकता है:

 Route::resource('/games', 'GameController')->only([ 'index', 'show', 'store', 'update', 'destroy' ]); 

अब, आप php artisan route:list साथ पथ देख सकते हैं php artisan route:list कमांड और इसका उपयोग करें।

बाकी एपीआई तैयार है!

 composer require laravel/passport php artisan make:auth php artisan passport:install php artisan migrate 

 public function boot() { $this->registerPolicies(); Passport::routes(); } 

 'api' => [ 'driver' => 'passport', 'provider' => 'users', ], 

 use App\User; use Illuminate\Support\Facades\Validator; 

 public function register (Request $request) { $validator = Validator::make($request->all(), [ 'name' => 'required|string|max:255', 'email' => 'required|string|email|max:255|unique:users', 'password' => 'required|string|min:6|confirmed', ]); if ($validator->fails()) { return response(['errors'=>$validator->errors()->all()], 422); } $request['password']=Hash::make($request['password']); $user = User::create($request->toArray()); $token = $user->createToken('Laravel Password Grant Client')->accessToken; $response = ['token' => $token]; return response($response, 200); } public function login (Request $request) { $user = User::where('email', $request->email)->first(); if ($user) { if (Hash::check($request->password, $user->password)) { $token = $user->createToken('Laravel Password Grant Client')->accessToken; $response = ['token' => $token]; return response($response, 200); } else { $response = "Password missmatch"; return response($response, 422); } } else { $response = 'User does not exist'; return response($response, 422); } } public function logout (Request $request) { $token = $request->user()->token(); $token->revoke(); $response = 'You have been succesfully logged out!'; return response($response, 200); } 

 Route::middleware('auth:api')->group(function () { ... Route::get('/logout', 'Api\AuthController@logout')->name('logout'); });