RetailCRM-Mirror/NelmioApiDocBundle
1
0
Fork 0
mirror of https://github.com/retailcrm/NelmioApiDocBundle.git synced 2025-02-09 02:59:27 +03:00
Code Issues Projects Releases Wiki Activity

Merge pull request #1777 from saleh199/add_yaml_doc

Browse Source 
Add Yaml Documentation
This commit is contained in:
Guilhem Niot 2021-02-16 01:01:33 +01:00 committed by GitHub
commit d074e05436
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 72 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
Controller/YamlDocumentationController.php Normal file
View File

@ -0,0 +1,47 @@
<?php
/*
* This file is part of the NelmioApiDocBundle package.
*
* (c) Nelmio
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Nelmio\ApiDocBundle\Controller;
use OpenApi\Annotations\OpenApi;
use OpenApi\Annotations\Server;
use Psr\Container\ContainerInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
final class YamlDocumentationController
{
private $generatorLocator;
public function __construct(ContainerInterface $generatorLocator)
{
$this->generatorLocator = $generatorLocator;
}
public function __invoke(Request $request, $area = 'default')
{
if (!$this->generatorLocator->has($area)) {
throw new BadRequestHttpException(sprintf('Area "%s" is not supported as it isn\'t defined in config.', $area));
}
/** @var OpenApi $spec */
$spec = $this->generatorLocator->get($area)->generate();
if ('' !== $request->getBaseUrl()) {
$spec->servers = [new Server(['url' => $request->getSchemeAndHttpHost().$request->getBaseUrl()])];
}
return new Response($spec->toYaml(), 200, [
'Content-Type' => 'text/x-yaml',
]);
}
}

8
Resources/config/services.xml
View File

@ -16,7 +16,13 @@
<argument type="service" id="twig" />
</service>
<service id="nelmio_api_doc.controller.swagger" class="Nelmio\ApiDocBundle\Controller\DocumentationController" public="true">
<service id="nelmio_api_doc.controller.swagger" alias="nelmio_api_doc.controller.swagger_json" public="true" />
<service id="nelmio_api_doc.controller.swagger_json" class="Nelmio\ApiDocBundle\Controller\DocumentationController" public="true">
<argument type="service" id="nelmio_api_doc.generator_locator" />
</service>
<service id="nelmio_api_doc.controller.swagger_yaml" class="Nelmio\ApiDocBundle\Controller\YamlDocumentationController" public="true">
<argument type="service" id="nelmio_api_doc.generator_locator" />
</service>

16
Tests/Functional/SwaggerUiTest.php
View File

@ -11,6 +11,7 @@
namespace Nelmio\ApiDocBundle\Tests\Functional;
use OpenApi\Annotations\Server;
use Symfony\Bundle\FrameworkBundle\KernelBrowser;
class SwaggerUiTest extends WebTestCase
@ -72,4 +73,19 @@ class SwaggerUiTest extends WebTestCase
$this->assertEquals($expected, json_decode($response->getContent(), true));
}
public function testYamlDocs()
{
$this->client->request('GET', '/app_dev.php/docs.yaml');
$response = $this->client->getResponse();
$this->assertEquals(200, $response->getStatusCode());
$this->assertEquals('text/x-yaml; charset=UTF-8', $response->headers->get('Content-Type'));
$spec = $this->getOpenApiDefinition();
$spec->servers = [new Server(['url' => 'http://api.example.com/app_dev.php'])];
$expected = $spec->toYaml();
$this->assertEquals($expected, $response->getContent());
}
}

3
Tests/Functional/TestKernel.php
View File

@ -87,7 +87,8 @@ class TestKernel extends Kernel
$routes->import(__DIR__.'/Controller/InvokableController.php', '/', 'annotation');
$routes->import('', '/api', 'api_platform');
$routes->add('/docs/{area}', 'nelmio_api_doc.controller.swagger_ui')->setDefault('area', 'default');
$routes->add('/docs.json', 'nelmio_api_doc.controller.swagger');
$routes->add('/docs.json', 'nelmio_api_doc.controller.swagger_json');
$routes->add('/docs.yaml', 'nelmio_api_doc.controller.swagger_yaml');
$routes->import(__DIR__.'/Controller/FOSRestController.php', '/', 'annotation');
if (class_exists(SerializedName::class)) {