Skip to content

Add 3.1 support #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
carnage merged 3 commits into from
Jan 8, 2025
Merged

Add 3.1 support #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
76537bc
Temporarily Depend on forked branch
charjr Nov 11, 2024
fc1ba20
Test support for OpenAPI 3.1
charjr Nov 11, 2024
7030bf7
Use devizzent fork again
charjr Nov 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,15 @@
},
"require": {
"php": "^8.1.0",
"membrane/openapi-reader": "2.1.0",
"membrane/openapi-reader": "^3.0",
"psr/http-message": "^1.0 || ^2.0",
"psr/log": "^3.0",
"symfony/console": "^6.0 || ^7.0"
},
"require-dev": {
"infection/infection": "^0.27.0",
"phpunit/phpunit": "^10.5.38",
"phpstan/phpstan": "^1.12.7",
"phpstan/phpstan": "^2.1.1",
"squizlabs/php_codesniffer": "^3.7",
"guzzlehttp/psr7": "^2.4",
"mikey179/vfsstream": "^1.6.7"
Expand Down
6 changes: 4 additions & 2 deletions src/Console/Service/CacheOpenAPIRoutes.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,10 @@ public function cache(
}

try {
$openApi = (new MembraneReader([OpenAPIVersion::Version_3_0]))
->readFromAbsoluteFilePath($openAPIFilePath);
$openApi = (new MembraneReader([
OpenAPIVersion::Version_3_0,
OpenAPIVersion::Version_3_1
]))->readFromAbsoluteFilePath($openAPIFilePath);
} catch (CannotRead $e) {
$this->logger->error($e->getMessage());
return false;
Expand Down
4 changes: 2 additions & 2 deletions src/RouteCollector.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@

namespace Membrane\OpenAPIRouter;

use Membrane\OpenAPIReader\ValueObject\Valid\V30\OpenAPI;
use Membrane\OpenAPIReader\ValueObject\Valid\{V30, V31};
use Membrane\OpenAPIRouter\Exception\CannotCollectRoutes;
use Membrane\OpenAPIRouter\Route\Server;

class RouteCollector
{
public function collect(OpenAPI $openApi): RouteCollection
public function collect(V30\OpenAPI|V31\OpenAPI $openApi): RouteCollection
{
$collection = [];

Expand Down
286 changes: 27 additions & 259 deletions tests/RouteCollectorTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,10 @@
use Membrane\OpenAPIRouter\Route;
use Membrane\OpenAPIRouter\RouteCollection;
use Membrane\OpenAPIRouter\RouteCollector;
use Membrane\OpenAPIRouter\Tests\Fixtures\ProvidesApiAndRoutes;
use PHPUnit\Framework\Attributes\CoversClass;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\DataProviderExternal;
use PHPUnit\Framework\Attributes\Test;
use PHPUnit\Framework\Attributes\UsesClass;
use PHPUnit\Framework\TestCase;
Expand All @@ -24,285 +26,51 @@
#[UsesClass(RouteCollection::class)]
class RouteCollectorTest extends TestCase
{
public const FIXTURES = __DIR__ . '/fixtures/';

#[Test]
public function throwExceptionIfThereAreNoRoutes(): void
public function itThrowsIfNoRoutes(): void
{
$openAPI = (new MembraneReader([OpenAPIVersion::Version_3_0]))
->readFromString(
json_encode([
'openapi' => '3.0.0',
'info' => ['title' => '', 'version' => '1.0.0'],
'paths' => []
]),
FileFormat::Json
);
->readFromString(json_encode([
'openapi' => '3.0.0',
'info' => ['title' => '', 'version' => '1.0.0'],
'paths' => []
]), FileFormat::Json);

self::expectExceptionObject(CannotCollectRoutes::noRoutes());

(new RouteCollector())->collect($openAPI);
}

#[Test]
public function removesDuplicateServers(): void
public function itRemovesDuplicateServers(): void
{
$openAPI = (new MembraneReader([OpenAPIVersion::Version_3_0]))
->readFromString(
json_encode([
'openapi' => '3.0.0',
'info' => ['title' => '', 'version' => '1.0.0'],
'servers' => [
['url' => 'https://www.server.net'],
['url' => 'https://www.server.net/'],
],
'paths' => [
'/path' => [
'get' => [
'operationId' => 'get-path',
'responses' => [200 => ['description' => 'Successful Response']]
]
]
]
]),
FileFormat::Json
);
->readFromString(json_encode([
'openapi' => '3.0.0',
'info' => ['title' => '', 'version' => '1.0.0'],
'servers' => [
['url' => 'https://www.server.net'],
['url' => 'https://www.server.net/'],
],
'paths' => ['/path' => ['get' => [
'operationId' => 'get-path',
'responses' => [200 => ['description' => 'Successful Response']]
]]]
]), FileFormat::Json);

$routeCollection = (new RouteCollector())->collect($openAPI);

self::assertCount(1, $routeCollection->routes['hosted']['static']);
}

public static function collectTestProvider(): Generator
{
yield 'petstore-expanded.json' => [
new RouteCollection([
'hosted' => [
'static' => [
'http://petstore.swagger.io/api' => [
'static' => [
'/pets' => [
'get' => 'findPets',
'post' => 'addPet',
],
],
'dynamic' => [
'regex' => '#^(?|/pets/([^/]+)(*MARK:/pets/{id}))$#',
'paths' => [
'/pets/{id}' => [
'get' => 'find pet by id',
'delete' => 'deletePet',
],
],
],
],
],
'dynamic' => [
'regex' => '#^(?|)#',
'servers' => [],
],
],
'hostless' => [
'static' => [],
'dynamic' => [
'regex' => '#^(?|)#',
'servers' => [],
],
],
]),
self::FIXTURES . 'docs/petstore-expanded.json',
];

yield 'WeirdAndWonderful.json' => [
new RouteCollection([
'hosted' => [
'static' => [
'http://weirdest.com' => [
'static' => [
'/however' => [
'put' => 'put-however',
'post' => 'post-however',
],
],
'dynamic' => [
'regex' => '#^(?|/and/([^/]+)(*MARK:/and/{name}))$#',
'paths' => [
'/and/{name}' => [
'get' => 'get-and',
],
],
],
],
'http://weirder.co.uk' => [
'static' => [
'/however' => [
'get' => 'get-however',
],
],
'dynamic' => [
'regex' => '#^(?|/and/([^/]+)(*MARK:/and/{name}))$#',
'paths' => [
'/and/{name}' => [
'put' => 'put-and',
'post' => 'post-and',
],
],
],
],
'http://wonderful.io' => [
'static' => [
'/or' => [
'post' => 'post-or',
],
'/xor' => [
'delete' => 'delete-xor',
],
],
'dynamic' => [
'regex' => '#^(?|)$#',
'paths' => [],
],
],
'http://wonderful.io/and' => [
'static' => [
'/or' => [
'post' => 'post-or',
],
'/xor' => [
'delete' => 'delete-xor',
],
],
'dynamic' => [
'regex' => '#^(?|)$#',
'paths' => [],
],
],
'http://wonderful.io/or' => [
'static' => [
'/or' => [
'post' => 'post-or',
],
'/xor' => [
'delete' => 'delete-xor',
],
],
'dynamic' => [
'regex' => '#^(?|)$#',
'paths' => [],
],
],
],
'dynamic' => [
'regex' => '#^(?|http://weird.io/([^/]+)(*MARK:http://weird.io/{conjunction}))#',
'servers' => [
'http://weird.io/{conjunction}' => [
'static' => [
'/or' => [
'post' => 'post-or',
],
'/xor' => [
'delete' => 'delete-xor',
],
],
'dynamic' => [
'regex' => '#^(?|)$#',
'paths' => [],
],
],
],
],
],
'hostless' => [
'static' => [
'' => [
'static' => [
'/or' => [
'post' => 'post-or',
],
'/xor' => [
'delete' => 'delete-xor',
],
],
'dynamic' => [
'regex' => '#^(?|)$#',
'paths' => [],
],
],
'/v1' => [
'static' => [
'/or' => [
'post' => 'post-or',
],
'/xor' => [
'delete' => 'delete-xor',
],
],
'dynamic' => [
'regex' => '#^(?|)$#',
'paths' => [],
],
],
],
'dynamic' => [
'regex' => '#^(?|/([^/]+)(*MARK:/{version}))#',
'servers' => [
'/{version}' => [
'static' => [
'/or' => [
'post' => 'post-or',
],
'/xor' => [
'delete' => 'delete-xor',
],
],
'dynamic' => [
'regex' => '#^(?|)$#',
'paths' => [],
],
],
],
],
],
]),
self::FIXTURES . 'WeirdAndWonderful.json',
];
yield 'APieceOfCake.json' => [
new RouteCollection([
'hosted' => ['static' => [], 'dynamic' => ['regex' => '#^(?|)#', 'servers' => []]],
'hostless' => [
'static' => [
'' => [
'static' => ['/cakes/sponge' => ['get' => 'findSpongeCakes']],
'dynamic' => [
'regex' => '#^(?|' .
'/cakes/([^/]+)(*MARK:/cakes/{icing})|' .
'/([^/]+)/sponge(*MARK:/{cakeType}/sponge)|' .
'/([^/]+)/([^/]+)(*MARK:/{cakeType}/{icing})' .
')$#',
'paths' => [
'/cakes/{icing}' => ['get' => 'findCakesByIcing', 'post' => 'addCakesByIcing'],
'/{cakeType}/sponge' => ['get' => 'findSpongeByDesserts'],
'/{cakeType}/{icing}' => [
'get' => 'findDessertByIcing',
'post' => 'addDessertByIcing'
]
]
]
],
],
'dynamic' => ['regex' => '#^(?|)#', 'servers' => []]
],
]),
self::FIXTURES . 'APIeceOfCake.json'
];
}

#[Test]
#[DataProvider('collectTestProvider')]
public function collectTest(RouteCollection $expected, string $apiFilePath): void
#[DataProviderExternal(ProvidesApiAndRoutes::class, 'defaultBehaviour')]
public function collectTest(string $apiFilePath, RouteCollection $expected): void
{
$openAPI = (new MembraneReader([OpenAPIVersion::Version_3_0]))
->readFromAbsoluteFilePath($apiFilePath);
$openAPI = (new MembraneReader([
OpenAPIVersion::Version_3_0,
OpenAPIVersion::Version_3_1,
]))->readFromAbsoluteFilePath($apiFilePath);

self::assertEquals($expected, (new RouteCollector())->collect($openAPI));
}
Expand Down
Loading
Loading