docuccino / laravel
Laravel adapter for Docuccino: route discovery, extension registry, pipeline and artisan export.
Package info
pkg:composer/docuccino/laravel
Requires
- php: ^8.3
- docuccino/attributes: v0.1.1
- docuccino/core: v0.1.1
- illuminate/console: ^12.0 || ^13.0
- illuminate/contracts: ^12.0 || ^13.0
- illuminate/routing: ^12.0 || ^13.0
- illuminate/support: ^12.0 || ^13.0
- spatie/laravel-package-tools: ^1.16
Requires (Dev)
- docuccino/inference-phpstan: v0.1.1
- lorisleiva/laravel-actions: ^2.0
- orchestra/testbench: ^10.0
- pestphp/pest: ^4.0
- spatie/laravel-data: ^4.0
- spatie/laravel-json-api-paginate: ^2.0
- timacdonald/json-api: ^1.0@beta
Suggests
- docuccino/inference-phpstan: Required for static type inference — install as a dev dependency: composer require --dev docuccino/inference-phpstan. Without it documentation comes from docblocks and attributes only.
README
This repository is a read-only subtree split of docuccino/docuccino. Open issues and pull requests on the monorepo — commits pushed here are overwritten.
The Laravel adapter for Docuccino — a UIR-based API documentation generator. It discovers your routes, runs the extension pipeline, and exports OpenAPI / UIR documents from the real shape of your code.
Install
To serve the docs from your app — the viewer live on a deployed environment:
composer require docuccino/laravel
composer require --dev docuccino/inference-phpstan # powers type inference
For docs you only read in development, or a spec you host elsewhere, keep both dev-only —
composer install --no-dev then ships neither:
composer require --dev docuccino/laravel docuccino/inference-phpstan
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.
Publish the config:
php artisan vendor:publish --tag=docuccino-config
Usage
Generate and export the default document:
php artisan docuccino:export
Other commands: docuccino:diff, docuccino:validate, docuccino:cache,
docuccino:clear. Register your own extensions from any service provider:
use Docuccino\Laravel\Facades\Docuccino; Docuccino::extend(MyOperationExtension::class);
Documentation
Full documentation is at https://docs.docuccino.app:
- Getting started
- Configuration reference
- Commands · Attributes
- Integrations
- Writing an integration · Docuccino vs Scramble
License
MIT. See LICENSE.