Download the PHP package docuccino/laravel without Composer

docuccino/laravel

Automatic OpenAPI documentation for Laravel APIs, generated from the real types in your code.

Docuccino reads your routes, form requests, API resources, Eloquent models and exception handling, and writes an OpenAPI 3.2 or 3.1 document — including the error responses your application actually returns. You get a Swagger-style reference you can serve, host anywhere, or gate your CI on, without hand-writing annotations to get started.

Then open the bundled Scalar viewer at /docs/api.

What you get

• Error responses without configuration — read from your app's real exception handling (render callbacks, render(), Responsable::toResponse()), with the thrown type narrowed so instanceof branches resolve.
• Query Builder parameters, recovered — allowedFilters, allowedSorts and allowedIncludes folded through helper methods several calls deep, with pagination parameters when the call graph reaches a paginating terminal.
• A semantic diff you can gate on — docuccino:diff --enforce compares two documents over stable identities and fails the build when a breaking change ships without the version bump its policy requires.
• Byte-deterministic output — identical code produces identical bytes, so a regenerated document never drifts and a diff only shows what really changed.
• Provenance for every field — docuccino:explain "POST /api/invoices" prints which layer produced each value and what it overrode.

Install

Where your docs need to be readable decides how you install.

Serve docs from your app — the viewer live on a deployed environment:

Docs in development only, or a document you host elsewhere (ReadMe, Bump.sh, any OpenAPI host) — keep both dev-only, so composer install --no-dev ships neither:

Analysis is a build-time job either way: the inference engine runs wherever you generate the document, never on a production host. Without the engine, documentation comes from docblocks and attributes only — and every export warns that it did.

Then:

It publishes config/docuccino.php (never replacing one you already have), reports how many of your routes the default api/* pattern matches and which prefixes they sit under when none do, says whether the engine is installed, and offers a first export.

Usage

Generate and export the default document:

Other commands: docuccino:install, docuccino:diff, docuccino:validate, docuccino:cache, docuccino:clear, and docuccino:explain "POST /api/invoices" — which prints, field by field, which precedence layer produced each value of one endpoint and what it overrode.

Register your own extensions from any service provider:

Contract testing

Docuccino\Laravel\Testing\AssertsApiContract holds the requests and responses your test suite already produces to the document Docuccino generates, and a failure names the producer and the file:line the schema came from. It also reports the documented endpoints your suite never exercises, validates every published example against its own schema, and gates breaking changes and a stale committed artifact.

ApiContract::record() turns the same seam into examples: the responses your suite produced are written to committed files, keyed by operation id and with credentials replaced, which the build reads. The document build still runs none of your endpoints — the execution happened in your tests.

Test-only: nothing registers it, and the service provider never touches it. See contract testing.

Part of Docuccino

Documentation

Full documentation is at docs.docuccino.app:

• Getting started
• Configuration reference
• Commands · Attributes
• Package support
• Writing an integration
• Comparisons: vs Scramble · vs Scribe

Issues and contributing

This repository is a read-only subtree split of docuccino/docuccino. Open issues and pull requests on the monorepo — commits pushed here are overwritten. See CONTRIBUTING.md.

License

MIT. See LICENSE.