quillphp/swagger

Interactive OpenAPI/Swagger UI plugin for the Quill framework.

dev-main 2026-04-04 18:33 UTC

Requires

• php: >=8.3
• quillphp/quill: ^0.0.1

Requires (Dev)

• phpunit/phpunit: ^11.0

MIT

README

Provides a lightweight, interactive OpenAPI/Swagger UI plugin for the Quill framework.

Instead of bundling heavy static assets locally, this plugin fetches the Swagger UI interface securely via a CDN, keeping the plugin footprint incredibly small while delivering a full-featured documentation page!

Installation

composer require quillphp/swagger

Usage

Register the plugin during the app bootstrap phase:

use Quill\App;
use Quill\Swagger\SwaggerPlugin;

$app = new App();

// Minimal configuration
$app->register(new SwaggerPlugin(
    file_path: __DIR__ . '/openapi.json'
));

$app->boot();

Configuration Options

You can completely customize the configuration using named arguments or array configuration:

$app->register(new SwaggerPlugin(
    path: '/docs',                               // The URL path to view the UI (default: /swagger)
    json_path: '/openapi.json',                  // The URL path for the JSON payload (default: /swagger.json)
    file_path: __DIR__ . '/resources/spec.json', // Path on your server to your local OpenAPI JSON file
    title: 'Quill API Docs'                      // Title of the web page
));

License

The MIT License (MIT). See License File for more information.