Symfony quickstart
bash
composer require --dev "studio-design/gesso:^3.0@beta" phpunit/phpunit symfony/http-foundation symfony/http-kernelPut the shared settings in a root gesso.php and register the extension in phpunit.xml. Gesso finds spec files through the PHPUnit extension, not a Symfony bundle:
php
<?php
// gesso.php, beside phpunit.xml
declare(strict_types=1);
return [
'spec' => [
'base_path' => 'openapi',
'names' => ['petstore'],
],
];xml
<extensions>
<bootstrap class="Studio\Gesso\PHPUnit\OpenApiCoverageExtension"/>
</extensions>Mix Studio\Gesso\Symfony\OpenApiAssertions into a PHPUnit or WebTestCase class and name the spec with #[OpenApiSpec] (or override openApiSpec()):
php
use PHPUnit\Framework\TestCase;
use Studio\Gesso\Attribute\OpenApiSpec;
use Studio\Gesso\Symfony\OpenApiAssertions;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
#[OpenApiSpec('petstore')]
class PetsApiTest extends TestCase
{
use OpenApiAssertions;
public function test_pets_index(): void
{
$request = Request::create('/pets', 'GET');
$response = new Response('[{"id":1,"name":"Fido"}]', 200, [
'Content-Type' => 'application/json',
]);
$this->assertOpenApiResponse($response, $request);
}
}The trait adds three assertions: assertOpenApiResponse($response, $request), assertOpenApiRequest($request), and assertOpenApiExchange($client), which runs both against the last client call.
Run the CI-tested examples/symfony fixture:
bash
composer testFor a full application, call assertOpenApiExchange($client) after KernelBrowser::request(). Both forms record coverage.