piairre / skuse
Modern OpenAPI documentation UI for Symfony — powered by skuse-ui
v0.1.2
2026-06-23 22:16 UTC
Requires
- php: >=8.1
- symfony/framework-bundle: ^6.4 || ^7.0 || ^8.0
- symfony/twig-bundle: ^6.4 || ^7.0 || ^8.0
This package is auto-updated.
Last update: 2026-06-23 22:19:20 UTC
README
Pronounced "skews"
/skjuːz/
A modern OpenAPI documentation viewer for Symfony, powered by skuse-ui.
Installation
composer require piairre/skuse
1. Register the bundle in config/bundles.php:
return [ // ... Piairre\Skuse\PiairreSkuseBundle::class => ['all' => true], ];
2. Configure the bundle — create config/packages/piairre_skuse.yaml:
piairre_skuse: open_api_url: '/docs.json' # path or full URL to your OpenAPI spec theme: system # light | dark | system (default: system)
3. Register the routes — create config/routes/piairre_skuse.yaml:
piairre_skuse: resource: '@PiairreSkuseBundle/config/routes.yaml' prefix: /skuse # change this to serve the docs at a different path
Configuration
| Option | Required | Default | Description |
|---|---|---|---|
open_api_url |
yes | — | Path or URL to your OpenAPI JSON/YAML spec |
theme |
no | system |
Color theme: light, dark, or system |
Requirements
- PHP >= 8.1
- Symfony >= 6.4