News

Laravel API Resources Artisan Command

Published
Laravel API Resources Artisan Command image

The Laravel Resources package is an artisan command for speeding up the development of APIs by creating the boilerplate code around a default API structure:

You interface with this package via the resources:create command, which will generate all the files you’ll need to build an API resource:

php artisan resources:create Post
Checking if the model exists ...
The model Post does not exist.
 
Should I create it? (yes/no) [yes]:
>
Should I create the migration for Post? (yes/no) [yes]:
>
Should I create the factory for Post? (yes/no) [yes]:
>
Should I create the seeder for Post? (yes/no) [yes]:
>
 
Creating 6 resources ...

The command will create the following files for you:

  • Controller
  • Form request
  • Resource and resource collection
  • Policy
  • Model
  • Database factory
  • Database migration
  • Database seeder
  • Routes

Here’s the format of the routes added to the routes/api.php file:

/*
|--------------------------------------------------------------------------
| Post endpoints
|--------------------------------------------------------------------------
*/
Route::name('posts.')->prefix('posts')->group(function () {
Route::get('/', 'PostControllerAPI@index')->name('index');
Route::post('/', 'PostControllerAPI@store')->name('create');
Route::get('/{post}', 'PostControllerAPI@show')->name('show');
Route::patch('/{post}', 'PostControllerAPI@update')->name('update');
Route::delete('/{post}', 'PostControllerAPI@destroy')->name('destroy');
});

The package has a customizable configuration which affects things like file location(s), filename prefix and suffixes. You can learn more about this package by checking out the code and readme on GitHub: LaravelResources.

Paul Redmond photo

Staff writer at Laravel News. Full stack web developer and author.

Filed in

Sponsored

serpapi logo
SerpApi

The Web Search API for Your LLM and AI Applications

Visit SerpApi

The latest

View all →
Volker Dusch on the PHP RCE Vulnerabilities and Disclosure image

Volker Dusch on the PHP RCE Vulnerabilities and Disclosure

Read article
Decide with Jev: Turn AI Answers into Decisions with PHP Rules image

Decide with Jev: Turn AI Answers into Decisions with PHP Rules

Read article
Skuul: Open-Source School Management Built on Laravel image

Skuul: Open-Source School Management Built on Laravel

Read article
Laravel Read Replicas: Prevent Stale Reads After a Write image

Laravel Read Replicas: Prevent Stale Reads After a Write

Read article
Screenshot: Capture Images and PDFs with PHP and Laravel image

Screenshot: Capture Images and PDFs with PHP and Laravel

Read article
Reset Sticky Database Connections Between Laravel Queue Jobs image

Reset Sticky Database Connections Between Laravel Queue Jobs

Read article