Download the PHP package ipsocode/hypervel-scribe without Composer
On this page you can find all versions of the php package ipsocode/hypervel-scribe. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download ipsocode/hypervel-scribe
More information about ipsocode/hypervel-scribe
Files in ipsocode/hypervel-scribe
Package hypervel-scribe
Short Description Generate API documentation for humans from your Hypervel codebase
License MIT
Homepage https://github.com/ipsocode/hypervel-scribe
Informations about the package hypervel-scribe
hypervel-scribe
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-devbranch ofhypervel/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.
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/componentsat0.4.x-dev(the package requires it whole, not its split packages)
Installation
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.
All versions of hypervel-scribe with dependencies
hypervel/components Version 0.4.x-dev
nikic/php-parser Version ^5.0
parsedown/parsedown Version ^1.7
ramsey/uuid Version ^4.2.2
symfony/var-exporter Version ^8.1
symfony/yaml Version ^8.1