PHPackages rossaddison/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. [API Development](/categories/api) 4. / 5. rossaddison/yii-swagger ActiveLibrary[API Development](/categories/api) rossaddison/yii-swagger ======================= OpenAPI Swagger for Yii Framework 0219PHP Since Jun 16Pushed 2y agoCompare [ Source](https://github.com/rossaddison/yii-swagger)[ Packagist](https://packagist.org/packages/rossaddison/yii-swagger)[ RSS](/packages/rossaddison-yii-swagger/feed)WikiDiscussions master Synced 3w ago READMEChangelogDependenciesVersions (1)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/bdeae736c545d35c96c32cb16fec73493ee95bc7d857b269938851c2e1ab49bf/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f7969692d737761676765722f762f737461626c652e706e67)](https://packagist.org/packages/yiisoft/yii-swagger)[![Total Downloads](https://camo.githubusercontent.com/8c8671058b817172c185de318345456f12b20a0d6edb3f6188dc8e869ac911c7/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f7969692d737761676765722f646f776e6c6f6164732e706e67)](https://packagist.org/packages/yiisoft/yii-swagger)[![Build status](https://github.com/yiisoft/yii-swagger/workflows/build/badge.svg)](https://github.com/yiisoft/yii-swagger/actions?query=workflow%3Abuild)[![Scrutinizer Code Quality](https://camo.githubusercontent.com/593a3af24728d02242e42aec9893f5a0965e5c008760d38a944804f6fe2c01e2/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f796969736f66742f7969692d737761676765722f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/yiisoft/yii-swagger/?branch=master)[![Code Coverage](https://camo.githubusercontent.com/fb9b41da5a9a2a4becc478dd418ac5cccf9d917b695ef5cb3b2fd8cff2b25a0c/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f796969736f66742f7969692d737761676765722f6261646765732f636f7665726167652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/yiisoft/yii-swagger/?branch=master)[![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.0 or higher. 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\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 [](#2-add-annotations-to-default-api-controller) ``` use OpenApi\Annotations as OA; /** * @OA\Info(title="My first API", version="1.0") */ class DefaultController { // ... } ``` and before actions ``` /** * @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 [](#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`: ``` //... '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 [](#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. '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 ------------- [](#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 16 — LowBetter than 4% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity11 Limited adoption so far Community16 Small or concentrated contributor base Maturity18 Early-stage or recently created project 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. ### Community Maintainers ![](https://www.gravatar.com/avatar/79f16141a5b619c098d6bec3812cd770dfc9b48eacc093f4ef88fbf20e735ec1?d=identicon)[yii2house2house](/maintainers/yii2house2house) --- 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)")[![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] (13 commits)")[![vjik](https://avatars.githubusercontent.com/u/525501?v=4)](https://github.com/vjik "vjik (9 commits)")[![iamsaint](https://avatars.githubusercontent.com/u/1016350?v=4)](https://github.com/iamsaint "iamsaint (8 commits)")[![rustamwin](https://avatars.githubusercontent.com/u/16498265?v=4)](https://github.com/rustamwin "rustamwin (6 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)")[![rossaddison](https://avatars.githubusercontent.com/u/8538339?v=4)](https://github.com/rossaddison "rossaddison (3 commits)")[![Fantom409](https://avatars.githubusercontent.com/u/14968877?v=4)](https://github.com/Fantom409 "Fantom409 (2 commits)")[![bautrukevich](https://avatars.githubusercontent.com/u/1747220?v=4)](https://github.com/bautrukevich "bautrukevich (1 commits)")[![thenotsoft](https://avatars.githubusercontent.com/u/44147615?v=4)](https://github.com/thenotsoft "thenotsoft (1 commits)")[![sankaest](https://avatars.githubusercontent.com/u/21160342?v=4)](https://github.com/sankaest "sankaest (1 commits)")[![viktorprogger](https://avatars.githubusercontent.com/u/7670669?v=4)](https://github.com/viktorprogger "viktorprogger (1 commits)") ### Embed Badge ![Health badge](/badges/rossaddison-yii-swagger/health.svg) ``` [![Health](https://phpackages.com/badges/rossaddison-yii-swagger/health.svg)](https://phpackages.com/packages/rossaddison-yii-swagger) ``` ### Alternatives [exsyst/swagger A php library to manipulate Swagger specifications 35816.3M7](/packages/exsyst-swagger)[hubspot/api-client Hubspot API client 24015.5M18](/packages/hubspot-api-client)[pocketmine/bedrock-protocol An implementation of the Minecraft: Bedrock Edition protocol in PHP 172437.8k11](/packages/pocketmine-bedrock-protocol)[botman/driver-telegram Telegram driver for BotMan 93452.6k6](/packages/botman-driver-telegram)[pixelant/pxa-social-feed Add Facebook, Instagram, and Twitter feeds to your site. 2349.3k](/packages/pixelant-pxa-social-feed) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)