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

Merge pull request #1404 from bifidokk/area-docs

Browse Source 
Separated documentation for areas
This commit is contained in:
Guilhem N 2018-10-06 14:44:53 +02:00 committed by GitHub
commit cd40d556cb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 60 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
DependencyInjection/Configuration.php
View File

@ -48,10 +48,10 @@ final class Configuration implements ConfigurationInterface
->end()
->arrayNode('areas')
->info('Filter the routes that are documented')
->defaultValue(['default' => ['path_patterns' => [], 'host_patterns' => []]])
->defaultValue(['default' => ['path_patterns' => [], 'host_patterns' => [], 'documentation' => []]])
->beforeNormalization()
->ifTrue(function ($v) {
return 0 === count($v) || isset($v['path_patterns']) || isset($v['host_patterns']);
return 0 === count($v) || isset($v['path_patterns']) || isset($v['host_patterns']) || isset($v['documentation']);
})
->then(function ($v) {
return ['default' => $v];
@ -77,6 +77,13 @@ final class Configuration implements ConfigurationInterface
->example(['^api\.'])
->prototype('scalar')->end()
->end()
->arrayNode('documentation')
->useAttributeAsKey('key')
->defaultValue([])
->info('The documentation used for area')
->example(['info' => ['title' => 'My App']])
->prototype('variable')->end()
->end()
->end()
->end()
->end()

40
DependencyInjection/NelmioApiDocExtension.php
View File

@ -13,6 +13,7 @@ namespace Nelmio\ApiDocBundle\DependencyInjection;
use FOS\RestBundle\Controller\Annotations\ParamInterface;
use Nelmio\ApiDocBundle\ApiDocGenerator;
use Nelmio\ApiDocBundle\Describer\ExternalDocDescriber;
use Nelmio\ApiDocBundle\Describer\RouteDescriber;
use Nelmio\ApiDocBundle\Describer\SwaggerPhpDescriber;
use Nelmio\ApiDocBundle\ModelDescriber\BazingaHateoasModelDescriber;
@ -64,27 +65,13 @@ final class NelmioApiDocExtension extends Extension implements PrependExtensionI
$nameAliases = $this->findNameAliases($config['models']['names'], $area);
$container->register(sprintf('nelmio_api_doc.generator.%s', $area), ApiDocGenerator::class)
->setPublic(false)
->setPublic(true)
->addMethodCall('setAlternativeNames', [$nameAliases])
->setArguments([
new TaggedIteratorArgument(sprintf('nelmio_api_doc.describer.%s', $area)),
new TaggedIteratorArgument('nelmio_api_doc.model_describer'),
]);
if (0 === count($areaConfig['path_patterns']) && 0 === count($areaConfig['host_patterns'])) {
$container->setDefinition(sprintf('nelmio_api_doc.routes.%s', $area), $routesDefinition)
->setPublic(false);
} else {
$container->register(sprintf('nelmio_api_doc.routes.%s', $area), RouteCollection::class)
->setPublic(false)
->setFactory([
(new Definition(FilteredRouteCollectionBuilder::class))
->addArgument($areaConfig),
'filter',
])
->addArgument($routesDefinition);
}
$container->register(sprintf('nelmio_api_doc.describers.route.%s', $area), RouteDescriber::class)
->setPublic(false)
->setArguments([
@ -103,6 +90,29 @@ final class NelmioApiDocExtension extends Extension implements PrependExtensionI
new Reference('logger'),
])
->addTag(sprintf('nelmio_api_doc.describer.%s', $area), ['priority' => -200]);
$container->register(sprintf('nelmio_api_doc.describers.config.%s', $area), ExternalDocDescriber::class)
->setPublic(false)
->setArguments([
$areaConfig['documentation'],
true,
])
->addTag(sprintf('nelmio_api_doc.describer.%s', $area), ['priority' => 990]);
unset($areaConfig['documentation']);
if (0 === count($areaConfig['path_patterns']) && 0 === count($areaConfig['host_patterns'])) {
$container->setDefinition(sprintf('nelmio_api_doc.routes.%s', $area), $routesDefinition)
->setPublic(false);
} else {
$container->register(sprintf('nelmio_api_doc.routes.%s', $area), RouteCollection::class)
->setPublic(false)
->setFactory([
(new Definition(FilteredRouteCollectionBuilder::class))
->addArgument($areaConfig),
'filter',
])
->addArgument($routesDefinition);
}
}
$container->register('nelmio_api_doc.generator_locator')

10
Tests/DependencyInjection/ConfigurationTest.php
View File

@ -22,16 +22,16 @@ class ConfigurationTest extends TestCase
$processor = new Processor();
$config = $processor->processConfiguration(new Configuration(), [['areas' => ['path_patterns' => ['/foo']]]]);
$this->assertSame(['default' => ['path_patterns' => ['/foo'], 'host_patterns' => []]], $config['areas']);
$this->assertSame(['default' => ['path_patterns' => ['/foo'], 'host_patterns' => [], 'documentation' => []]], $config['areas']);
}
public function testAreas()
{
$processor = new Processor();
$config = $processor->processConfiguration(new Configuration(), [['areas' => $areas = [
'default' => ['path_patterns' => ['/foo'], 'host_patterns' => []],
'internal' => ['path_patterns' => ['/internal'], 'host_patterns' => ['^swagger\.']],
'commercial' => ['path_patterns' => ['/internal'], 'host_patterns' => []],
'default' => ['path_patterns' => ['/foo'], 'host_patterns' => [], 'documentation' => []],
'internal' => ['path_patterns' => ['/internal'], 'host_patterns' => ['^swagger\.'], 'documentation' => []],
'commercial' => ['path_patterns' => ['/internal'], 'host_patterns' => [], 'documentation' => []],
]]]);
$this->assertSame($areas, $config['areas']);
@ -136,6 +136,6 @@ class ConfigurationTest extends TestCase
$processor = new Processor();
$config = $processor->processConfiguration(new Configuration(), [['routes' => ['path_patterns' => ['/foo']]]]);
$this->assertSame(['default' => ['path_patterns' => ['/foo'], 'host_patterns' => []]], $config['areas']);
$this->assertSame(['default' => ['path_patterns' => ['/foo'], 'host_patterns' => [], 'documentation' => []]], $config['areas']);
}
}

4
Tests/DependencyInjection/NelmioApiDocExtensionTest.php
View File

@ -24,8 +24,8 @@ class NelmioApiDocExtensionTest extends TestCase
$extension = new NelmioApiDocExtension();
$extension->load([[
'areas' => [
'default' => ['path_patterns' => ['/foo'], 'host_patterns' => []],
'commercial' => ['path_patterns' => ['/internal'], 'host_patterns' => []],
'default' => ['path_patterns' => ['/foo']],
'commercial' => ['path_patterns' => ['/internal']],
],
'models' => [
'names' => [

3
Tests/Functional/FunctionalTest.php
View File

@ -19,7 +19,8 @@ class FunctionalTest extends WebTestCase
{
public function testConfiguredDocumentation()
{
$this->assertEquals('My Test App', $this->getSwaggerDefinition()->getInfo()->getTitle());
$this->assertEquals('My Default App', $this->getSwaggerDefinition()->getInfo()->getTitle());
$this->assertEquals('My Test App', $this->getSwaggerDefinition('test')->getInfo()->getTitle());
}
public function testUndocumentedAction()

1
Tests/Functional/SwaggerUiTest.php
View File

@ -41,6 +41,7 @@ class SwaggerUiTest extends WebTestCase
yield ['/docs', 'default', $expected];
// Api-platform documentation
$expected['info']['title'] = 'My Test App';
$expected['paths'] = [
'/api/dummies' => $expected['paths']['/api/dummies'],
'/api/foo' => $expected['paths']['/api/foo'],

17
Tests/Functional/TestKernel.php
View File

@ -119,7 +119,7 @@ class TestKernel extends Kernel
$c->loadFromExtension('nelmio_api_doc', [
'documentation' => [
'info' => [
'title' => 'My Test App',
'title' => 'My Default App',
],
'definitions' => [
'Test' => [
@ -140,8 +140,19 @@ class TestKernel extends Kernel
],
],
'areas' => [
'default' => ['path_patterns' => ['^/api(?!/admin)'], 'host_patterns' => ['^api\.']],
'test' => ['path_patterns' => ['^/test'], 'host_patterns' => ['^api-test\.']],
'default' => [
'path_patterns' => ['^/api(?!/admin)'],
'host_patterns' => ['^api\.'],
],
'test' => [
'path_patterns' => ['^/test'],
'host_patterns' => ['^api-test\.'],
'documentation' => [
'info' => [
'title' => 'My Test App',
],
],
],
],
]);
}

4
Tests/Functional/WebTestCase.php
View File

@ -22,11 +22,11 @@ class WebTestCase extends BaseWebTestCase
return new TestKernel();
}
protected function getSwaggerDefinition()
protected function getSwaggerDefinition($area = 'default')
{
static::createClient([], ['HTTP_HOST' => 'api.example.com']);
return static::$kernel->getContainer()->get('nelmio_api_doc.generator')->generate();
return static::$kernel->getContainer()->get(sprintf('nelmio_api_doc.generator.%s', $area))->generate();
}
protected function getModel($name): Schema