Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yiisoft/yii-swagger
Swagger integration for Yii
https://github.com/yiisoft/yii-swagger
api hacktoberfest openapi swagger swagger-ui yii3
Last synced: about 11 hours ago
JSON representation
Swagger integration for Yii
- Host: GitHub
- URL: https://github.com/yiisoft/yii-swagger
- Owner: yiisoft
- License: bsd-3-clause
- Created: 2020-09-25T14:21:56.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-04-03T21:23:58.000Z (6 months ago)
- Last Synced: 2024-04-15T03:05:35.291Z (5 months ago)
- Topics: api, hacktoberfest, openapi, swagger, swagger-ui, yii3
- Language: PHP
- Homepage: https://www.yiiframework.com/
- Size: 153 KB
- Stars: 27
- Watchers: 18
- Forks: 6
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
Yii Swagger
[](https://packagist.org/packages/yiisoft/yii-swagger)
[](https://packagist.org/packages/yiisoft/yii-swagger)
[](https://github.com/yiisoft/yii-swagger/actions/workflows/build.yml)
[](https://codecov.io/gh/yiisoft/yii-swagger)
[](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/yii-swagger/master)
[](https://github.com/yiisoft/yii-swagger/actions?query=workflow%3A%22static+analysis%22)
[](https://shepherd.dev/github/yiisoft/yii-swagger)
OpenAPI Swagger for Yii Framework.
## Requirements
- PHP 8.0 or higher.
## Installation
The package could be installed with [Composer](https://getcomposer.org):
```shell
composer require yiisoft/yii-swagger
```
## Configuration
### 1. Add route configuration to `config/routes.php`
```php
use Yiisoft\DataResponse\Middleware\FormatDataResponseAsHtml;
use Yiisoft\DataResponse\Middleware\FormatDataResponseAsJson;
use Yiisoft\Router\Group;
use Yiisoft\Router\Route;
use Yiisoft\Swagger\Middleware\SwaggerUi;
use Yiisoft\Swagger\Action\SwaggerJson;
// Swagger routes
Group::create('/swagger', [
Route::get('')
->middleware(FormatDataResponseAsHtml::class)
->action(fn (SwaggerUi $swaggerUi) => $swaggerUi->withJsonUrl('/swagger/json-url')),
Route::get('/json-url')
->middleware(FormatDataResponseAsJson::class)
->action(SwaggerJson::class),
]),
```
### 2. Add annotations to default API controller
```php
use OpenApi\Annotations as OA;
/**
* @OA\Info(title="My first API", version="1.0")
*/
class DefaultController {
// ...
}
```
and before actions
```php
/**
* @OA\Get(
* path="/api/endpoint",
* @OA\Response(response="200", description="Get default action")
* )
*/
public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
{
// ...
}
```
See [Swagger-PHP documentation](https://zircote.github.io/swagger-php/guide/annotations.html) 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`:
```php
//...
'yiisoft/yii-swagger' => [
'annotation-paths' => [
'@src/Controller' // Directory where annotations are used
],
'cacheTTL' => 60 // Enables caching and sets TTL, "null" value means infinite cache TTL.
],
//...
```
### 4. (Optional) Add config for aliases and asset manager
```php
use Yiisoft\Definitions\Reference;
use Yiisoft\Assets\AssetManager;
return [
//...
'yiisoft/aliases' => [
'aliases' => [
//...
'@views' => '@root/views',
'@assets' => '@public/assets',
'@assetsUrl' => '@baseUrl/assets',
],
],
'yiisoft/view' => [
'basePath' => '@views',
'defaultParameters' => [
'assetManager' => Reference::to(AssetManager::class),
]
],
//...
];
```
### 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`.
```php
//...
'yiisoft/yii-swagger' => [
'ui-params' => [
'persistAuthorization' => true,
],
],
//...
```
You can find a complete list of parameters by [following the link](https://swagger.io/docs/open-source-tools/swagger-ui/usage/configuration/).
### 6. (Optional) Configure `SwaggerService`
You can specify options for generation an `OpenApi\Annotations\OpenApi`
instance in `config/params.php` to configure `SwaggerService`:
```php
//...
'yiisoft/yii-swagger' => [
// Default values are specified.
'open-api-options' => [
'aliases' => OpenApi\Generator::DEFAULT_ALIASES,
'namespaces' => OpenApi\Generator::DEFAULT_NAMESPACES,
'analyser' => null,
'analysis' => null,
'processors' => null,
'logger' => null,
'validate' => true,
'version' => OpenApi\Annotations\OpenApi::DEFAULT_VERSION,
],
],
//...
```
For more information about generation an `OpenApi\Annotations\OpenApi` instance, see the
documentation of the [zircote/swagger-php](https://github.com/zircote/swagger-php) package.
## Documentation
- [Internals](docs/internals.md)
If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for that.
You may also check out other [Yii Community Resources](https://www.yiiframework.com/community).
## License
The Yii Swagger is free software. It is released under the terms of the BSD License.
Please see [`LICENSE`](./LICENSE.md) for more information.
Maintained by [Yii Software](https://www.yiiframework.com/).
## Support the project
[](https://opencollective.com/yiisoft)
## Follow updates
[](https://www.yiiframework.com/)
[](https://twitter.com/yiiframework)
[](https://t.me/yii3en)
[](https://www.facebook.com/groups/yiitalk)
[](https://yiiframework.com/go/slack)