ez-php / swagger-ui

2.5.6 2026-09-30 18:37 UTC

Requires

• php: ^8.5
• ez-php/contracts: ^2.0
• ez-php/http: ^2.0

Requires (Dev)

• ez-php/docker: ^2.0
• ez-php/framework: ^2.0
• friendsofphp/php-cs-fixer: ^3.94
• phpstan/phpstan: ^2.1
• phpstan/phpstan-deprecation-rules: ^2.0
• phpstan/phpstan-strict-rules: ^2.0
• phpunit/phpunit: ^13.0

MIT

• Andreas Uretschnig

• documentation
• php
• swagger-ui
• openapi
• redoc
• ez-php

Published on Packagist.org on 2026-09-30 18:42 UTC

README

Serves Swagger UI / ReDoc documentation for the OpenAPI spec produced by ez-php/openapi

Installation

composer require ez-php/swagger-ui

Usage

Register the service provider (typically in provider/modules.php):

$app->register(\EzPhp\SwaggerUI\SwaggerUiServiceProvider::class);

This registers GET /docs, rendering a Swagger UI page that fetches its spec from GET /openapi.json (see ez-php/openapi). Configure via config/swagger-ui.php or environment:

return [
    'endpoint' => getenv('SWAGGER_UI_ENDPOINT') ?: '/docs',
    'spec_url' => getenv('SWAGGER_UI_SPEC_URL') ?: '/openapi.json',
    'renderer' => getenv('SWAGGER_UI_RENDERER') ?: 'swagger-ui', // or 'redoc'
];

Both renderers load their assets from a CDN (jsDelivr), pinned to exact versions (swagger-ui-dist@5.33.0, redoc@2.5.4) with Subresource Integrity hashes — nothing is vendored by this module. Apply authentication or rate limiting to the /docs route in your own application's service provider if the documentation should not be publicly accessible.

License

MIT