README

OpenApi

Standalone OpenAPI 3.1 document builder for explicit PHP specifications, with optional Laravel route binding and Artisan generation support.

Requires PHP 8.5+

composer require cline/openapi

Optional Laravel integration:

composer require laravel/framework

Contract-first authoring: Define documents explicitly in PHP instead of relying on inferred annotations or reflection-heavy generation
Standalone core: No Laravel or framework dependency
Optional Laravel adapter: Bind endpoint specs to named Laravel routes, validate controller request handlers, scaffold explicit endpoint classes from real routes, and generate documents with php artisan openapi:generate
Versioned documents: Build one explicit OpenAPI document per API version
Typed builders: Use fluent builders for info, servers, operations, parameters, schemas, callbacks, links, request bodies, responses, and more
Reusable components: Register schemas, parameters, request bodies, responses, callbacks, examples, and links as named components
Reusable resource contracts: Define model-like API shapes once and emit related collection or JSON:API wrapper schemas from a single resource spec
Common API helpers: Build pagination, relationship, and filter or sort parameter contracts from dedicated helpers instead of ad-hoc arrays
JSON:API helpers: Generate JSON:API collection contracts without coupling the core package to a framework
Escape hatches: Use merge(...), component(...), and extension(...) when you need unusual OpenAPI shapes
Built-in validation: Detect duplicate operationId values and unresolved component references during generation, plus structural document drift like missing responses, invalid paths, and missing path parameters

Please see CHANGELOG for more information on what has changed recently.

Please see CONTRIBUTING and CODE_OF_CONDUCT for details.

If you discover any security related issues, please use the GitHub security reporting form rather than the issue queue.

The MIT License. Please see License File for more information.