# Laravel REST API 3 rewrites resource contracts — existing applications need a deliberate migration

Lomkit's Laravel REST API 3 replaces string-based fields with typed declarations and a unified validation and policy perimeter. Existing integrations need PHP and Laravel upgrades, resource rewrites and regression tests rather than a routine Composer update.

Laravel REST API 3 changes field declarations, query hooks, validation, docs and confirmations. PHP 8.3 and Laravel 13.30 are required.

- Status: Active
- Published: 2026-11-18T16:32:59+13:00
- Updated: 2026-11-18T16:32:59+13:00
- Categories: Web Development, PHP, Frameworks
- Tags: API migration, Laravel, open source
- Canonical HTML: https://beyondthe.news/dossiers/lomkit-laravel-rest-api-3-typed-fields-breaking-upgrade

## What changed

On 10 November 2026 Laravel News documented Lomkit's Laravel REST API 3 rewrite. The upstream upgrade guide confirms typed field/input declarations, a common request validation and authorisation perimeter, Scramble OpenAPI documentation, metrics endpoints and signed confirmations for sensitive operations. The 3.x series has already received further releases, so teams must consult the upgrade guide for their target version.

## Why it matters

A package that generates CRUD APIs from Eloquent resource classes sits at an application's authorisation boundary. This migration changes how fields, queries and writes are validated and exposed. Upgrading blindly can break client contracts or policy behaviour. Small Laravel teams need a compatibility inventory, controlled staging upgrade and targeted API regression tests.

## The resource contract has changed

In 2.x resource declarations could list column names; 3.x uses typed field objects that drive input validation, filters, response serialization and documentation. Query hooks consolidate into perimeterQuery(), and declarations no longer receive the old request argument. Overrides retaining old signatures can fail at PHP class loading.

## Compatibility is a hard gate

The official 3.0 upgrade guide requires PHP 8.3+ and Laravel 13.30+. Laravel 12 applications should remain on the 2.x line until the framework is upgraded. Laravel Scout integrations require version 11.9+, while Scramble ^0.13.48 is used for OpenAPI documentation.

## Safer writes require client awareness

The package introduces signed confirmation tokens and HTTP 428 responses for operations requiring confirmation. Clients must handle that handshake rather than assume all write requests either succeed or return conventional validation errors. Later 3.x changes also adjust 422 and 409 behaviour for specific invalid relation operations.

## Migration needs testing, not only documentation

The maintainer's guide recommends updating resource classes, running php artisan rest:check, checking php artisan route:list and exercising tests after each step. Verify authorisation boundaries, relationship mutations, filters, pagination, response shape and generated OpenAPI against real clients. The documentation establishes intended behaviour, not proof that an individual application will migrate without regressions.

## Key details

- Version 3.0 was reported on 10 November 2026; the upstream upgrade guide now covers subsequent 3.x changes.
- PHP 8.3+ and Laravel 13.30+ are required for the 3.x line.
- Typed fields replace earlier string declarations and affect filtering, validation and response output.
- Scramble replaces previous built-in API documentation approach.
- Signed confirmation tokens can require clients to respond to HTTP 428.
- The official guide details later changes in response serialization and validation status codes.

## Builder takeaways

- Inventory all lomkit/laravel-rest-api resource declarations and overridden methods before updating.
- Upgrade PHP and Laravel prerequisites in staging first; Laravel 12 projects should stay on 2.x.
- Use the upstream upgrade guide for the exact destination version, not only the 3.0 headline.
- Run rest:check, route:list, policy tests and client contract tests including destructive writes and relationships.
- Review signed confirmation-token handling and OpenAPI output before production rollout.

## What to watch

- Further 3.x migration fixes and backward-compatibility notes.
- Independent reports of policy or client-contract regressions during upgrades.
- Support floors for Laravel and PHP releases.

## Uncertainties

- No independent multi-application migration benchmark or regression rate was established.
- The official guide describes intended security and validation properties; it does not replace application-specific testing.
- Package release cadence is fast and exact patch requirements may change.

## Sources

- [Upgrade guide](https://laravel-rest-api.lomkit.com/getting-started/upgrade-guide) — Lomkit · primary documentation · 2026-11-18T00:00:00+13:00. Live maintainer guide covering 3.0 and later changes, compatibility, migrations and validation.
- [Introduction and comparison](https://laravel-rest-api.lomkit.com/getting-started/introduction) — Lomkit · primary documentation · 2026-11-18T00:00:00+13:00. Scope, architecture and alternatives.
- [Laravel REST API 3.0: Typed Fields, Metrics, and OpenAPI Docs](https://laravel-news.com/laravel-rest-api-3) — Laravel News · independent specialist reporting · 2026-11-10T00:00:00+13:00. Release context and practical examples.

