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.

Laravel Forge logo

Laravel Forge

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

Laravel Forge
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 $7500/mo. ⬧ No lengthy sales process. ⬧ No contracts. ⬧ 100% money back guarantee.

No Compromises
Kirschbaum logo

Kirschbaum

Providing innovation and stability to ensure your web application succeeds.

Kirschbaum
Shift logo

Shift

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

Shift
Bacancy logo

Bacancy

Supercharge your project with a seasoned Laravel developer with 4-6 years of experience for just $2500/month. Get 160 hours of dedicated expertise & a risk-free 15-day trial. Schedule a call now!

Bacancy
Lucky Media logo

Lucky Media

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

Lucky Media
Lunar: Laravel E-Commerce logo

Lunar: Laravel E-Commerce

E-Commerce for Laravel. An open-source package that brings the power of modern headless e-commerce functionality to Laravel.

Lunar: Laravel E-Commerce
LaraJobs logo

LaraJobs

The official Laravel job board

LaraJobs
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
Supercharge Your SaaS Development with FilamentFlow: The Ultimate Laravel Filament Boilerplate logo

Supercharge Your SaaS Development with FilamentFlow: The Ultimate Laravel Filament Boilerplate

Build your SaaS application in hours. Out-of-the-box multi-tenancy and seamless Stripe integration. Supports subscriptions and one-time purchases, allowing you to focus on building and creating without repetitive setup tasks.

Supercharge Your SaaS Development with FilamentFlow: The Ultimate Laravel Filament Boilerplate
Rector logo

Rector

Your partner for seamless Laravel upgrades, cutting costs, and accelerating innovation for successful companies

Rector
MongoDB logo

MongoDB

Enhance your PHP applications with the powerful integration of MongoDB and Laravel, empowering developers to build applications with ease and efficiency. Support transactional, search, analytics and mobile use cases while using the familiar Eloquent APIs. Discover how MongoDB's flexible, modern database can transform your Laravel applications.

MongoDB

The latest

View all →
Herd Executable Support and Pest 3 Mutation Testing in PhpStorm 2024.3 image

Herd Executable Support and Pest 3 Mutation Testing in PhpStorm 2024.3

Read article
Register now for Sentry Launch Week! image

Register now for Sentry Launch Week!

Read article
Hide and safeguard emails from bots with the Muddle Laravel package image

Hide and safeguard emails from bots with the Muddle Laravel package

Read article
Dynamic Cache, Database, and Mail Builders in Laravel 11.31 image

Dynamic Cache, Database, and Mail Builders in Laravel 11.31

Read article
PHPStan 2.0 is Here image

PHPStan 2.0 is Here

Read article
Run multiple CLI commands locally at once with Solo for Laravel image

Run multiple CLI commands locally at once with Solo for Laravel

Read article