README

Dependency-free PHP attributes for documenting an HTTP API, used by Docuccino.

These attributes annotate controllers, actions, closure routes and the types they use, so the Docuccino pipeline can patch or add documentation where your code cannot say it on its own — a description, a query parameter, an example, a security requirement.

The package has no dependencies beyond PHP itself, which is the point: a library can expose Docuccino annotations to its users without pulling in a documentation toolchain. If you are documenting a Laravel application, you want docuccino/laravel, which pulls this in for you.

Install

composer require docuccino/attributes

Usage

use Docuccino\Attributes\Description;
use Docuccino\Attributes\QueryParameter;

final class InvoiceController
{
    #[QueryParameter(name: 'status', type: 'string', description: 'Filter by status')]
    public function index() { /* … */ }
}

#[Description(text: 'Everything an invoice carries once it has been issued.')]
final class InvoiceData { /* … */ }

Part of Docuccino

Package	Role
`docuccino/laravel`	The Laravel adapter: provider, config, commands, viewer, integrations. Start here.
`docuccino/core`	Framework-agnostic document model, canonicalizer, identities, emitters, diff.
`docuccino/inference-phpstan`	PHPStan + Larastan type inference. Install as a dev dependency.
`docuccino/attributes` ← you are here	Dependency-free PHP attribute classes.

Documentation

Every attribute — with signatures and examples — is documented in the attributes reference at docs.docuccino.app.

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.

docuccino / attributes

Package info

Security

Statistics