PHPackages                             yiisoft/yii-swagger - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. yiisoft/yii-swagger

ActiveLibrary[Framework](/categories/framework)

yiisoft/yii-swagger
===================

OpenAPI Swagger for Yii Framework

2.2.0(1y ago)31116.9k—0%8[1 issues](https://github.com/yiisoft/yii-swagger/issues)BSD-3-ClausePHPPHP ^8.1CI passing

Since Dec 15Pushed 2mo ago14 watchersCompare

[ Source](https://github.com/yiisoft/yii-swagger)[ Packagist](https://packagist.org/packages/yiisoft/yii-swagger)[ Docs](https://www.yiiframework.com/)[ GitHub Sponsors](https://github.com/sponsors/yiisoft)[ OpenCollective](https://opencollective.com/yiisoft)[ RSS](/packages/yiisoft-yii-swagger/feed)WikiDiscussions master Synced today

READMEChangelog (6)Dependencies (24)Versions (10)Used By (0)

 [ ![Yii](https://camo.githubusercontent.com/8317c17418b39410a660f5149071d26c5023c0d5fb2b7ebb771324812f666d73/68747470733a2f2f796969736f66742e6769746875622e696f2f646f63732f696d616765732f7969695f6c6f676f2e737667) ](https://github.com/yiisoft)

Yii Swagger
===========

[](#yii-swagger)

[![Latest Stable Version](https://camo.githubusercontent.com/788926f2ccdc0cee2b6a4d0a46b29025c78164ce55e64dc00b8af0287dc4b0c1/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f7969692d737761676765722f76)](https://packagist.org/packages/yiisoft/yii-swagger)[![Total Downloads](https://camo.githubusercontent.com/0fb6fada6b2ed9dedff935f0711fa4e698e42584961d2430101575f00909ab90/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f7969692d737761676765722f646f776e6c6f616473)](https://packagist.org/packages/yiisoft/yii-swagger)[![Build status](https://github.com/yiisoft/yii-swagger/actions/workflows/build.yml/badge.svg)](https://github.com/yiisoft/yii-swagger/actions/workflows/build.yml)[![Code Coverage](https://camo.githubusercontent.com/b7fc027cf84920ced8c27301ec83f418a64d0bb00d33b2c05372a5ed4af99bfc/68747470733a2f2f636f6465636f762e696f2f67682f796969736f66742f7969692d737761676765722f67726170682f62616467652e7376673f746f6b656e3d4b3836553933315a524b)](https://codecov.io/gh/yiisoft/yii-swagger)[![Mutation testing badge](https://camo.githubusercontent.com/79ae1b9b3928dec83c5ee7d46002ccd9cc6a0acc84dbc6f703743538ed500298/68747470733a2f2f696d672e736869656c64732e696f2f656e64706f696e743f7374796c653d666c61742675726c3d687474707325334125324625324662616467652d6170692e737472796b65722d6d757461746f722e696f2532466769746875622e636f6d253246796969736f66742532467969692d737761676765722532466d6173746572)](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/yii-swagger/master)[![static analysis](https://github.com/yiisoft/yii-swagger/workflows/static%20analysis/badge.svg)](https://github.com/yiisoft/yii-swagger/actions?query=workflow%3A%22static+analysis%22)[![type-coverage](https://camo.githubusercontent.com/8380999d4ca73d9464692274f477e32cc465c106461882959f3026f2cf80ce4b/68747470733a2f2f73686570686572642e6465762f6769746875622f796969736f66742f7969692d737761676765722f636f7665726167652e737667)](https://shepherd.dev/github/yiisoft/yii-swagger)

OpenAPI Swagger for Yii Framework.

Requirements
------------

[](#requirements)

- PHP 8.1 - 8.5.

Installation
------------

[](#installation)

The package could be installed with [Composer](https://getcomposer.org):

```
composer require yiisoft/yii-swagger
```

Configuration
-------------

[](#configuration)

### 1. Add route configuration to `config/routes.php`

[](#1-add-route-configuration-to-configroutesphp)

```
use Yiisoft\DataResponse\Middleware\FormatDataResponseAsHtml;
use Yiisoft\DataResponse\Middleware\FormatDataResponseAsJson;
use Yiisoft\Router\Group;
use Yiisoft\Router\Route;
use Yiisoft\Yii\Swagger\Action\SwaggerUi;
use Yiisoft\Yii\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 attributes to default API controller

[](#2-add-attributes-to-default-api-controller)

```
use OpenApi\Attributes as OA;

#[OA\Info(title:"My first API", version:"1.0")]
class DefaultController {
    // ...
}
```

and before actions

```
use OpenApi\Attributes as OA;

#[OA\Get(
    path: "/api/endpoint",
    summary: "Get default endpoint",
    responses: [
        new 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/attributes.html) for details on how to annotate your code.

### 3. Configure `SwaggerJson` action

[](#3-configure-swaggerjson-action)

For attributes to be registered you need to configure `SwaggerJson`.

You can use the parameters in `config/params.php` to configure `SwaggerJson`:

```
//...
'yiisoft/yii-swagger' => [
    'source-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

[](#4-optional-add-config-for-aliases-and-asset-manager)

```
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

[](#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`.

```
//...
'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`

[](#6-optional-configure-swaggerservice)

You can specify options for generation an `OpenApi\Annotations\OpenApi`instance in `config/params.php` to configure `SwaggerService`:

```
//...
'yiisoft/yii-swagger' => [
    // Default values are specified.
    'options' => [
        'aliases' => [],
        'namespaces' => [],
        'config' => [],
        'validate' => true,
        'version' => OpenApi\Annotations\OpenApi::DEFAULT_VERSION,
    ],
],
//...
```

Or you can specify definition of `OpenApi\Generator` in `di-web.php`:

```
use Yiisoft\Yii\Swagger\Service\SwaggerService;

return [
    Generator::class => [
        'setAnalyser' => [myAnalyser()],
    ],
    //...
]
```

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
-------------

[](#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
-------

[](#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
-------------------

[](#support-the-project)

[![Open Collective](https://camo.githubusercontent.com/a2b15f8e2268d4e3842e00d41ff7a57cce2ad8bd8d8769c5dc4fa05a546a4f62/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4f70656e253230436f6c6c6563746976652d73706f6e736f722d3765616466313f6c6f676f3d6f70656e253230636f6c6c656374697665266c6f676f436f6c6f723d376561646631266c6162656c436f6c6f723d353535353535)](https://opencollective.com/yiisoft)

Follow updates
--------------

[](#follow-updates)

[![Official website](https://camo.githubusercontent.com/d6b0929173e28cc627430d2519ca1853466a70f37395877eaf4820cb3e1e1909/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f506f77657265645f62792d5969695f4672616d65776f726b2d677265656e2e7376673f7374796c653d666c6174)](https://www.yiiframework.com/)[![Twitter](https://camo.githubusercontent.com/d077c362ac639792171af8bc002ee827816733dfc0925f70b557e6d151022226/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f747769747465722d666f6c6c6f772d3144413146323f6c6f676f3d74776974746572266c6f676f436f6c6f723d314441314632266c6162656c436f6c6f723d3535353535353f7374796c653d666c6174)](https://twitter.com/yiiframework)[![Telegram](https://camo.githubusercontent.com/4e38dd12535575c39c65bea7119b95e663abb2d1f4e3d669a27bbda07ef603f0/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f74656c656772616d2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d74656c656772616d)](https://t.me/yii3en)[![Facebook](https://camo.githubusercontent.com/48204e301b34b29b0815854544f04c337fc0692096cab35e9a1f8c53a42c2307/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f66616365626f6f6b2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d66616365626f6f6b266c6f676f436f6c6f723d666666666666)](https://www.facebook.com/groups/yiitalk)[![Slack](https://camo.githubusercontent.com/1a3645ba1c97e6684d0349bc478201e1621ba0d3efad516d81035364d442bad7/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f736c61636b2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d736c61636b)](https://yiiframework.com/go/slack)

###  Health Score

53

↑

FairBetter than 97% of packages

Maintenance68

Regular maintenance activity

Popularity43

Moderate usage in the ecosystem

Community28

Small or concentrated contributor base

Maturity63

Established project with proven stability

 Bus Factor3

3 contributors hold 50%+ of commits

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~142 days

Recently: every ~228 days

Total

9

Last Release

418d ago

Major Versions

1.2.2 → 2.0.02023-02-16

PHP version history (2 changes)1.0.0PHP ^8.0

2.2.0PHP ^8.1

### Community

Maintainers

![](https://www.gravatar.com/avatar/261a6249c6f605f3956a2fae40fbb813f6b2e1e6f2bf806180c851a965426e54?d=identicon)[cebe](/maintainers/cebe)

![](https://www.gravatar.com/avatar/fc29e4e7068a00fe9b9db37b8aadda1db6020adcacef810461e47b99c2b150e6?d=identicon)[samdark](/maintainers/samdark)

![](https://www.gravatar.com/avatar/ccb75e3312d6bd454ea445ea308139fd185a4ca906ca5df21cc66e6a35de25a3?d=identicon)[SilverFire](/maintainers/SilverFire)

![](https://www.gravatar.com/avatar/99106256c24a8cb23871b99fa90e48f37f1aa71608c185759b7d2a88683a5918?d=identicon)[hiqsol](/maintainers/hiqsol)

---

Top Contributors

[![samdark](https://avatars.githubusercontent.com/u/47294?v=4)](https://github.com/samdark "samdark (45 commits)")[![xepozz](https://avatars.githubusercontent.com/u/6815714?v=4)](https://github.com/xepozz "xepozz (19 commits)")[![vjik](https://avatars.githubusercontent.com/u/525501?v=4)](https://github.com/vjik "vjik (17 commits)")[![devanych](https://avatars.githubusercontent.com/u/20116244?v=4)](https://github.com/devanych "devanych (16 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (15 commits)")[![rustamwin](https://avatars.githubusercontent.com/u/16498265?v=4)](https://github.com/rustamwin "rustamwin (13 commits)")[![arogachev](https://avatars.githubusercontent.com/u/8326201?v=4)](https://github.com/arogachev "arogachev (12 commits)")[![iamsaint](https://avatars.githubusercontent.com/u/1016350?v=4)](https://github.com/iamsaint "iamsaint (8 commits)")[![terabytesoftw](https://avatars.githubusercontent.com/u/42547589?v=4)](https://github.com/terabytesoftw "terabytesoftw (6 commits)")[![luizcmarin](https://avatars.githubusercontent.com/u/67489841?v=4)](https://github.com/luizcmarin "luizcmarin (3 commits)")[![Fantom409](https://avatars.githubusercontent.com/u/14968877?v=4)](https://github.com/Fantom409 "Fantom409 (2 commits)")[![sankaest](https://avatars.githubusercontent.com/u/21160342?v=4)](https://github.com/sankaest "sankaest (1 commits)")[![mspirkov](https://avatars.githubusercontent.com/u/63721828?v=4)](https://github.com/mspirkov "mspirkov (1 commits)")[![thenotsoft](https://avatars.githubusercontent.com/u/44147615?v=4)](https://github.com/thenotsoft "thenotsoft (1 commits)")[![viktorprogger](https://avatars.githubusercontent.com/u/7670669?v=4)](https://github.com/viktorprogger "viktorprogger (1 commits)")[![bautrukevich](https://avatars.githubusercontent.com/u/1747220?v=4)](https://github.com/bautrukevich "bautrukevich (1 commits)")

---

Tags

apihacktoberfestopenapiswaggerswagger-uiyii3apiswaggeryii

###  Code Quality

TestsPHPUnit

Static AnalysisPsalm, Rector

Type Coverage Yes

### Embed Badge

![Health badge](/badges/yiisoft-yii-swagger/health.svg)

```
[![Health](https://phpackages.com/badges/yiisoft-yii-swagger/health.svg)](https://phpackages.com/packages/yiisoft-yii-swagger)
```

###  Alternatives

[slim/slim

Slim is a PHP micro framework that helps you quickly write simple yet powerful web applications and APIs

12.2k49.0M1.1k](/packages/slim-slim)[yiisoft/app

Yii3 web application template

35011.3k](/packages/yiisoft-app)[yiisoft/view

Yii View Rendering Library

56368.7k14](/packages/yiisoft-view)[yiisoft/app-api

Yii3 API project template

971.5k](/packages/yiisoft-app-api)[yiisoft/yii-middleware

Yii Middleware

21148.4k1](/packages/yiisoft-yii-middleware)[yiisoft/yii-view-renderer

PSR-7 compatible view renderer

1755.7k6](/packages/yiisoft-yii-view-renderer)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
