PHPackages sunrise/http-router-openapi - 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. [HTTP & Networking](/categories/http) 4. / 5. sunrise/http-router-openapi Abandoned → [sunrise/http-router-openapi](/?search=sunrise%2Fhttp-router-openapi)ArchivedLibrary[HTTP & Networking](/categories/http) sunrise/http-router-openapi =========================== Sunrise // OpenApi (Swagger) Specification support for Sunrise Router v2.2.0(4y ago)42.8k1[4 issues](https://github.com/sunrise-php/http-router-openapi/issues)[10 PRs](https://github.com/sunrise-php/http-router-openapi/pulls)MITPHPPHP ^7.1|^8.0 Since Jan 5Pushed 1y ago1 watchersCompare [ Source](https://github.com/sunrise-php/http-router-openapi)[ Packagist](https://packagist.org/packages/sunrise/http-router-openapi)[ Docs](https://github.com/sunrise-php/http-router-openapi)[ RSS](/packages/sunrise-http-router-openapi/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (10)Dependencies (7)Versions (37)Used By (0) OpenAPI (Swagger) Specification Support for Sunrise Router ---------------------------------------------------------- [](#openapi-swagger-specification-support-for-sunrise-router) [![Build Status](https://camo.githubusercontent.com/9074392d1b847f6b600752a1f31d22c923df3a5838b34d86083ab24d93051def/68747470733a2f2f636972636c6563692e636f6d2f67682f73756e726973652d7068702f687474702d726f757465722d6f70656e6170692e7376673f7374796c653d736869656c64)](https://circleci.com/gh/sunrise-php/http-router-openapi)[![Code Coverage](https://camo.githubusercontent.com/f71b450e6344dd436abb2e31546870247028823e09ae6c78d0add2230b3bc393/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f73756e726973652d7068702f687474702d726f757465722d6f70656e6170692f6261646765732f636f7665726167652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/sunrise-php/http-router-openapi/?branch=master)[![Scrutinizer Code Quality](https://camo.githubusercontent.com/337e9060c9ff09a73d13d71f684874ecafa419567348e6cdf00db5e1bda82239/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f73756e726973652d7068702f687474702d726f757465722d6f70656e6170692f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/sunrise-php/http-router-openapi/?branch=master)[![Total Downloads](https://camo.githubusercontent.com/c4b58f90385bfd09abe6843a222e6010c9ab7a4f77f5841b4ce1a5cd0ad8bff9/68747470733a2f2f706f7365722e707567782e6f72672f73756e726973652f687474702d726f757465722d6f70656e6170692f646f776e6c6f6164733f666f726d61743d666c6174)](https://packagist.org/packages/sunrise/http-router-openapi)[![Latest Stable Version](https://camo.githubusercontent.com/54bccb402b2665e5d483d5d869b7d34273d5e1a836981546facd8eea65af27b5/68747470733a2f2f706f7365722e707567782e6f72672f73756e726973652f687474702d726f757465722d6f70656e6170692f762f737461626c653f666f726d61743d666c6174)](https://packagist.org/packages/sunrise/http-router-openapi)[![License](https://camo.githubusercontent.com/1211e570adbed7bd9de4a6402d4a28b60aeb3714cc148e8057f67f9cfe2c8b69/68747470733a2f2f706f7365722e707567782e6f72672f73756e726973652f687474702d726f757465722d6f70656e6170692f6c6963656e73653f666f726d61743d666c6174)](https://packagist.org/packages/sunrise/http-router-openapi) --- Important to understanding -------------------------- [](#important-to-understanding) - [OpenAPI Specification](https://github.com/OAI/OpenAPI-Specification/blob/6ba1577240b79c9f613c2ea8d745c6ef6c832e50/versions/3.0.2.md) Installation ------------ [](#installation) ``` composer require 'sunrise/http-router-openapi:^2.1' ``` QuickStart ---------- [](#quickstart) ``` use Psr\SimpleCache\CacheInterface; use Sunrise\Http\Router\OpenApi\Object\Info; use Sunrise\Http\Router\OpenApi\OpenApi; use Sunrise\Http\Router\OpenApi\RouteInterface; $openapi = new OpenApi(new Info('Acme', '1.0.0')); // Passing PSR-16 cache to the openapi object: /** @var CacheInterface $cache */ $openapi->setCache($cache); // Passing all routes to the openapi object: /** @var RouteInterface[] $routes */ $openapi->addRoute(...$routes); // When using Sunrise Router: /** @var \Sunrise\Http\Router\Router $router */ $openapi->addRoute(...$router->getRoutes()); ``` #### Building OpenAPI Document [](#building-openapi-document) ``` // Converting the openapi object to JSON document: $openapi->toJson(); // Converting the openapi object to YAML document: $openapi->toYaml(); // Converting the openapi object to an array: $openapi->toArray(); ``` #### Building JSON Schemas [](#building-json-schemas) > Converts an operation part to [JSON Schema](https://json-schema.org). ``` $openapi->getRequestCookieJsonSchema(); $openapi->getRequestHeaderJsonSchema(); $openapi->getRequestQueryJsonSchema(); $openapi->getRequestBodyJsonSchema(); $openapi->getResponseBodyJsonSchema(); ``` PSR-15 Middlewares ------------------ [](#psr-15-middlewares) #### RequestValidationMiddleware [](#requestvalidationmiddleware) > Validates a request using a route description. ``` use Sunrise\Http\Router\OpenApi\Middleware\RequestValidationMiddleware; use Sunrise\Http\Router\OpenApi\OpenApi; /** @var OpenApi $openapi */ $middleware = new RequestValidationMiddleware($openapi); ``` Symfony Commands ---------------- [](#symfony-commands) #### GenerateOpenapiDocumentCommand [](#generateopenapidocumentcommand) > Generates OpenAPI document. ``` use Sunrise\Http\Router\OpenApi\Command\GenerateOpenapiDocumentCommand; use Sunrise\Http\Router\OpenApi\OpenApi; /** @var OpenApi $openapi */ $command = new GenerateOpenapiDocumentCommand($openapi); ``` ``` php bin/app router:generate-openapi-document --help ``` #### GenerateJsonSchemaCommand [](#generatejsonschemacommand) > Generates an operation part to [JSON Schema](https://json-schema.org). ``` use Sunrise\Http\Router\OpenApi\Command\GenerateJsonSchemaCommand; use Sunrise\Http\Router\OpenApi\OpenApi; /** @var OpenApi $openapi */ $command = new GenerateJsonSchemaCommand($openapi); ``` ``` php bin/app router:generate-json-schema --help ``` Test Kit -------- [](#test-kit) #### assertResponseBodyMatchesDescription [](#assertresponsebodymatchesdescription) > The assertion fails if the given response body doesn't match a description of the operation identified by the given ID. ``` use PHPUnit\Framework\TestCase; use Psr\Http\Message\ResponseInterface; use Sunrise\Http\Router\OpenApi\Test\OpenapiTestKit; class SomeTest extends TestCase { use OpenapiTestKit; public function testResponseBodyMatchesDescription() : void { // some logic to run a route... /** @var ResponseInterface $response */ $this->assertResponseBodyMatchesDescription('route.name', $response); } } ``` Simple Route Description ------------------------ [](#simple-route-description) ``` class SomeController { /** * @OpenApi\Operation( * requestBody=@OpenApi\RequestBody( * content={ * "application/json": @OpenApi\MediaType( * schema=@OpenApi\Schema( * type="object", * properties={ * "foo": @OpenApi\Schema( * type="string", * ), * }, * ), * ), * }, * ), * responses={ * 200: @OpenApi\Response( * description="Ok", * ), * }, * ) */ public function someAction() { } } ``` --- Look for more examples here: [Some App](https://github.com/sunrise-php/http-router-openapi/tree/be27acedfc1f100f8efdcdd9da9430714890baa3/tests/fixtures/SomeApp) ### Health Score 34 — LowBetter than 77% of packages Maintenance13 Infrequent updates — may be unmaintained Popularity25 Limited adoption so far Community10 Small or concentrated contributor base Maturity73 Established project with proven stability Bus Factor1 Top contributor holds 96.9% of commits — single point of failure 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 ~37 days Recently: every ~67 days Total 19 Last Release 1650d ago Major Versions v1.10.0 → v2.0.02021-10-07 PHP version history (2 changes)v1.0.0PHP ^7.1 v1.8.0PHP ^7.1|^8.0 ### Community Maintainers ![](https://avatars.githubusercontent.com/u/2872934?v=4)[Anatolii Nekhai](/maintainers/fenric)[@fenric](https://github.com/fenric) --- Top Contributors [![fenric](https://avatars.githubusercontent.com/u/2872934?v=4)](https://github.com/fenric "fenric (125 commits)")[![renovate-bot](https://avatars.githubusercontent.com/u/25180681?v=4)](https://github.com/renovate-bot "renovate-bot (4 commits)") --- Tags annotationslaravellumenopenapiphpphp-libraryphp7php8routersunrise-phpswaggersymfonyhttprouterswaggeropenapiannotationsPHP7php8sunrisefenric ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/sunrise-http-router-openapi/health.svg) ``` [![Health](https://phpackages.com/badges/sunrise-http-router-openapi/health.svg)](https://phpackages.com/packages/sunrise-http-router-openapi) ``` ### Alternatives [sunrise/http-router A powerful solution as the foundation of your project. 16249.8k10](/packages/sunrise-http-router)[sunrise/vin VIN decoder for PHP 7.1+ based on ISO-3779 83127.0k](/packages/sunrise-vin)[sunrise/http-message An HTTP message implementation based on PSR-7, PSR-17 and RFC-7230. 15112.3k15](/packages/sunrise-http-message)[tobion/openapi-symfony-routing Loads routes in Symfony based on OpenAPI/Swagger annotations 4219.5k](/packages/tobion-openapi-symfony-routing)[sunrise/http-client-curl A simple cURL client implementing PSR-18. 187.5k](/packages/sunrise-http-client-curl)[sunrise/slugger Slugger for PHP 7.1+ based on ICU 108.3k](/packages/sunrise-slugger) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)