API Platform for Laravel

Last updated on by

API Platform for Laravel image

The API Platform is the easiest way to create state-of-the-art web APIs using Symfony or Laravel:

API Platform is a set of tools for building modern web projects. It is a framework for API-first projects built on top of Symfony components. Like other modern frameworks such as Laravel and Symfony, it’s both a full-stack all-in-one framework and a set of independent PHP components and bundles that can be used separately.

Main Features

  • Expose your Eloquent models in minutes as a REST API or GraphQL API
  • Or both at the same time, with the same code!
  • Automatically expose an OpenAPI specification, dynamically generated from your Eloquent models and always up-to-date
  • Automatic CRUD
  • Automatically expose nice UIs and playgrounds to develop using your API
  • Automatically paginate collections
  • Add validation logic using Laravel Form Request Validation
  • API Platform is compatible with Laravel's authorization system - add authorization logic using gates and policies
  • Add filtering logic
  • Benefits from the API Platform JavaScript tools: admin and create client
  • And more...

Here are a few examples from the documentation of how you can expose your Eloquent models to enable validation, query parameters, filtering, authentication, and more.

First, here's an example of how you can use API Platform with Laravel Sanctum to add a middleware to secure routes:

// app/Models/Book.php
 
use ApiPlatform\Metadata\Patch;
 
#[Patch(middleware: 'auth:sanctum')]
class Book extends Model
{
}

Next, here's an example of using API Platform's integration for exposing an Eloquent model as an API resource with validation rules:

// app/Models/Book.php
 
use ApiPlatform\Metadata\ApiResource;
 
#[ApiResource(
rules: [
'title' => 'required',
]
)]
class Book extends Model
{
}

To get started with API Platform and Laravel, read the documentation for installing Laravel and the API platform. Specifically, Installing the API Platform docs will walk you through setting up API platform on a new Laravel project, creating your first model, using DTOs, and more. You don't have to start a new project to use API Platform with Laravel, you can add it to your existing app as well.

Paul Redmond photo

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

Cube

Laravel Newsletter

Join 40k+ other developers and never miss out on new tips, tutorials, and more.

image
Laravel Cloud

Easily create and manage your servers and deploy your Laravel applications in seconds.

Visit Laravel Cloud
Harpoon: Next generation time tracking and invoicing logo

Harpoon: Next generation time tracking and invoicing

The next generation time-tracking and billing software that helps your agency plan and forecast a profitable future.

Harpoon: Next generation time tracking and invoicing
Shift logo

Shift

Running an old Laravel version? Instant, automated Laravel upgrades and code modernization to keep your applications fresh.

Shift
Laravel Cloud logo

Laravel Cloud

Easily create and manage your servers and deploy your Laravel applications in seconds.

Laravel Cloud
Lucky Media logo

Lucky Media

Get Lucky Now - the ideal choice for Laravel Development, with over a decade of experience!

Lucky Media
Kirschbaum logo

Kirschbaum

Providing innovation and stability to ensure your web application succeeds.

Kirschbaum
Acquaint Softtech logo

Acquaint Softtech

Acquaint Softtech offers AI-ready Laravel developers who onboard in 48 hours at $3000/Month with no lengthy sales process and a 100 percent money-back guarantee.

Acquaint Softtech
Tinkerwell logo

Tinkerwell

The must-have code runner for Laravel developers. Tinker with AI, autocompletion and instant feedback on local and production environments.

Tinkerwell
No Compromises logo

No Compromises

Joel and Aaron, the two seasoned devs from the No Compromises podcast, are now available to hire for your Laravel project. ⬧ Flat rate of $9500/mo. ⬧ No lengthy sales process. ⬧ No contracts. ⬧ 100% money back guarantee.

No Compromises
SaaSykit: Laravel SaaS Starter Kit logo

SaaSykit: Laravel SaaS Starter Kit

SaaSykit is a Multi-tenant Laravel SaaS Starter Kit that comes with all features required to run a modern SaaS. Payments, Beautiful Checkout, Admin Panel, User dashboard, Auth, Ready Components, Stats, Blog, Docs and more.

SaaSykit: Laravel SaaS Starter Kit
PhpStorm logo

PhpStorm

The go-to PHP IDE with extensive out-of-the-box support for Laravel and its ecosystem.

PhpStorm

The latest

View all →
Monitor and Control Schedules, Queues, and Errors in Laravel with Watchtower image

Monitor and Control Schedules, Queues, and Errors in Laravel with Watchtower

Read article
Showcase Your PhpStorm Expertise on LinkedIn image

Showcase Your PhpStorm Expertise on LinkedIn

Read article
Privacy Filter: Detect PII in Text from Laravel image

Privacy Filter: Detect PII in Text from Laravel

Read article
NationForge: A Self-Hosted Admin Panel for Civic Organizations image

NationForge: A Self-Hosted Admin Panel for Civic Organizations

Read article
Monitor Laravel Queues, Commands, and Schedulers on Any Driver with Vigilance image

Monitor Laravel Queues, Commands, and Schedulers on Any Driver with Vigilance

Read article
Watch the Teaser for 'The Story of PHP' Documentary image

Watch the Teaser for 'The Story of PHP' Documentary

Read article