Download the PHP package radebatz/openapi-extras without Composer
On this page you can find all versions of the php package radebatz/openapi-extras. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download radebatz/openapi-extras
More information about radebatz/openapi-extras
Files in radebatz/openapi-extras
Package openapi-extras
Short Description Extra annotations for OpenApi/swagger-php.
License MIT
Homepage http://radebatz.net/mano/
Informations about the package openapi-extras
openapi-extras
Introduction
Extra attributes/annotations and other bits for swagger-php.
Installation
You can use composer or simply download the release.
Composer
The preferred method is via composer. Follow the installation instructions if you do not already have composer installed.
Once composer is installed, execute the following command in your project root to install this library:
Registering the library
Use of the included annotations/attributes requires registration of a custom swagger-php
processor.
Also, in the case of annotations, the registration of custom aliases / namespaces needs to be done manually.
Using the Builder
When using the OpenApiBuilder
no additional registration code is required as the builder will always
configure the required MergeControllerDefaults
processor.
Register library for attributes
Register library for annotations
Basic usage
OpenApiBuilder
The builder aims to simplify configuring the swagger-php
Generator
class by implementing
explicit methods to configure all default processors.
Futhermore, it also adds a new Customizer
processor which allows to pre-process all instances
of a given OpenApi annotation/attribute by registering callbacks.
Controller
The controller annotation may be used to:
- add an optional url prefix to all operations in the class
- share one or more
Response
s across all operations - share one or more
Header
's across all operations - share one or more
Middleware
's across all operations
Example for adding the /foo
prefix and a 403
response to all operations in the MyController
class.
Middleware
The Middleware
annotation is currently not used but will be used by a future version
of the openapi-router project.
Middleware
annotations allow to share a list of middleware names either individually or across all operations (via the Controller
annotation).
License
The openapi-extras project is released under the MIT license.
All versions of openapi-extras with dependencies
psr/log Version ^2.0 || ^3.0
psr/simple-cache Version ^1.0 || ^2.0 || ^3.0
zircote/swagger-php Version ^4.11.1 || ^5.0