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', 'admin@info.fr')
    ->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/