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

Merge pull request #975 from nelmio/TAGS

Browse Source 
Support @SWG\Tag
This commit is contained in:
Guilhem Niot 2017-03-21 18:44:38 +01:00 committed by GitHub
commit f5d8020098
3 changed files with 14 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
Describer/SwaggerPhpDescriber.php
View File

@ -87,6 +87,7 @@ final class SwaggerPhpDescriber extends ExternalDocDescriber implements ModelReg
'filename' => $method->getFileName(),
]);
$implicitAnnotations = [];
$tags = [];
foreach ($annotations as $annotation) {
$annotation->_context = $context;
@ -114,6 +115,13 @@ final class SwaggerPhpDescriber extends ExternalDocDescriber implements ModelReg
continue;
}
if ($annotation instanceof SWG\Tag) {
$annotation->validate();
$tags[] = $annotation->name;
continue;
}
if (!$annotation instanceof SWG\Response && !$annotation instanceof SWG\Parameter && !$annotation instanceof SWG\ExternalDocumentation) {
throw new \LogicException(sprintf('Using the annotation "%s" as a root annotation in "%s::%s()" is not allowed.', get_class($annotation), $method->getDeclaringClass()->name, $method->name));
}
@ -121,13 +129,13 @@ final class SwaggerPhpDescriber extends ExternalDocDescriber implements ModelReg
$implicitAnnotations[] = $annotation;
}
if (0 === count($implicitAnnotations)) {
if (0 === count($implicitAnnotations) && 0 === count($tags)) {
continue;
}
foreach ($httpMethods as $httpMethod) {
$annotationClass = $operationAnnotations[$httpMethod];
$operation = new $annotationClass(['_context' => $context, 'path' => $path, 'value' => $implicitAnnotations]);
$operation = new $annotationClass(['_context' => $context, 'path' => $path, 'value' => $implicitAnnotations, 'tags' => $tags]);
$analysis->addAnnotation($operation, null);
}
}

1
Tests/Functional/Controller/ApiController.php
View File

@ -51,6 +51,7 @@ class ApiController
* @Model(type=User::class)
* )
* )
* @SWG\Tag(name="implicit")
*/
public function implicitSwaggerAction()
{

3
Tests/Functional/FunctionalTest.php
View File

@ -12,6 +12,7 @@
namespace Nelmio\ApiDocBundle\Tests\Functional;
use EXSyst\Component\Swagger\Operation;
use EXSyst\Component\Swagger\Tag;
use EXSyst\Component\Swagger\Schema;
use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
@ -62,6 +63,8 @@ class FunctionalTest extends WebTestCase
{
$operation = $this->getOperation('/api/swagger/implicit', $method);
$this->assertEquals(array(new Tag('implicit')), $operation->getTags());
$responses = $operation->getResponses();
$this->assertTrue($responses->has('201'));
$response = $responses->get('201');