Download the PHP package yiisoft/yii-swagger without Composer
On this page you can find all versions of the php package yiisoft/yii-swagger. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download yiisoft/yii-swagger
More information about yiisoft/yii-swagger
Files in yiisoft/yii-swagger
Package yii-swagger
Short Description OpenAPI Swagger for Yii Framework
License BSD-3-Clause
Homepage https://www.yiiframework.com/
Informations about the package yii-swagger
Yii Swagger
OpenAPI Swagger for Yii Framework.
Requirements
- PHP 8.0 or higher.
Installation
The package could be installed with Composer:
Configuration
1. Add route configuration to config/routes.php
2. Add annotations to default API controller
and before actions
See Swagger-PHP documentation for details on how to annotate your code.
3. Configure SwaggerJson
action
For annotations to be registered you need to configure SwaggerJson
.
You can use the parameters in config/params.php
to configure SwaggerJson
:
4. (Optional) Add config for aliases and asset manager
5. (Optional) Configure SwaggerUi
action
You can use the parameters in config/params.php
to configure SwaggerUi
.
For example, you can enable persisting authorization by setting the persistAuthorization
parameter to true
.
You can find a complete list of parameters by following the link.
6. (Optional) Configure SwaggerService
You can specify options for generation an OpenApi\Annotations\OpenApi
instance in config/params.php
to configure SwaggerService
:
For more information about generation an OpenApi\Annotations\OpenApi
instance, see the
documentation of the zircote/swagger-php package.
Documentation
- Internals
If you need help or have a question, the Yii Forum is a good place for that. You may also check out other Yii Community Resources.
License
The Yii Swagger is free software. It is released under the terms of the BSD License.
Please see LICENSE
for more information.
Maintained by Yii Software.
Support the project
Follow updates
All versions of yii-swagger with dependencies
psr/http-message Version ^1.0|^2.0
psr/http-server-handler Version ^1.0
psr/http-server-middleware Version ^1.0
swagger-api/swagger-ui Version ^4.1|^5.0
yiisoft/aliases Version ^1.1|^2.0|^3.0
yiisoft/arrays Version ^3.0
yiisoft/assets Version ^2.0|^3.0|^4.0
yiisoft/cache Version ^1.0|^2.0|^3.0
yiisoft/data-response Version ^1.0|^2.0
yiisoft/html Version ^3.0
yiisoft/yii-view-renderer Version ^7.1.0
zircote/swagger-php Version ^4.0