openxtrem/oas-generator

4.0.0 2024-06-03 20:16 UTC

Requires

• php: 8.2.* | 8.3.*
• ext-json: *
• cebe/php-openapi: 1.7.*
• symfony/routing: ^6.4

Requires (Dev)

• openxtrem/coding-standard: ^1.0.0
• phpunit/phpunit: 9.5.*
• symfony/var-dumper: ^6.4

proprietary

• Xtrem Santé - Interopérabilité

README

About

Convert Symfony routes collection to Open Api Specifications. OAS validation with cebe/php-openapi

How to use :

$oas = new Specifications();
$oas->setVersion('1.0.0')
    ->setTitle('OX APIs documentation')
    ->setDescription('This documentation ...')
    ->setContact('admin', '[e-mail]')
    ->setLicense('GPL', 'https://openxtrem.com/licenses/gpl.html')
    ->addTag('system', 'This is a tag');
    ->addServer('http://lorem-ipsum.fr', 'description')
    ->addSecurity(
        'Token', 'apiKey', 'header token', [
                   'in'   => 'header',
                   'name' => 'X-OXAPI-KEY',
               ])
    ->addSchema(new Scheam('lorem', 'object'));

$routes = new RouteCollection(); // your routes

$generator     = new Generator($oas, $routes);
$documentation = $generator->generate();

How to tests ?

 vendor/bin/phpunit -c phpunit.xml

Need help ?

https://www.openapis.org/