ipsocode / hypervel-scribe

v0.2.5 2026-10-21 07:51 UTC

Requires

• fakerphp/faker: ^1.24
• hypervel/components: 0.4.x-dev
• nikic/php-parser: ^5.0
• parsedown/parsedown: ^1.7
• ramsey/uuid: ^4.2.2
• symfony/var-exporter: ^8.1
• symfony/yaml: ^8.1

Requires (Dev)

• brianium/paratest: ^7.27.2
• filp/whoops: ^2.15
• friendsofphp/php-cs-fixer: ^3.57.2
• hypervel/testbench: ^0.4
• league/fractal: ^0.20 || ^0.21
• mockery/mockery: ^1.6
• nunomaduro/collision: ^8.0
• phpstan/phpstan: ^2.2.15
• phpunit/phpunit: ~13.4.3

MIT

• Ipsocode

• documentation
• api
• coroutine
• Scribe
• Postman
• openapi
• hypervel

Published on Packagist.org on 2026-10-21 07:56 UTC

README

Generate API documentation from your Hypervel routes: a browsable HTML page, an OpenAPI 3 spec and a Postman collection.

Warning

Development only — do not use this package in production until Hypervel 0.4 is released.

It is built for Hypervel 0.4, which has no release yet: 0.4 exists only as the 0.4.x-dev branch of hypervel/components, and this package is developed and tested against that moving branch. Until 0.4 ships, anything here can change without a deprecation period — the API, the configuration and the generated output included. Use it to evaluate or to build against Hypervel 0.4, and pin the version you tested.

#[Group('Posts')]
#[BodyParam('title', 'string', 'The headline.', example: 'Hello, world')]
public function store(StorePostRequest $request): PostResource

With these attributes from Ipsocode\Scribe\Attributes on a controller method, php artisan scribe:generate documents its endpoint on the page at /docs.

Requirements

• PHP 8.4 or newer (CI runs 8.4 and 8.5)
• Hypervel 0.4, which today means hypervel/components at 0.4.x-dev (the package requires it whole, not its split packages)

Installation

composer require ipsocode/hypervel-scribe
php artisan vendor:publish --tag=scribe-config

Your application's composer.json must allow Hypervel's dev branch: "minimum-stability": "dev" together with "prefer-stable": true.

Documentation

Start with getting started; the documentation index lists every page.

Contributing

See CONTRIBUTING.md. Report security issues privately, as described in SECURITY.md, rather than in a public issue.

Credits

A port of knuckleswtf/scribe by Shalvah and its contributors, to Hypervel. LICENSE carries its copyright notice alongside this package's.

License

MIT. See LICENSE.