Merge pull request #1297 from magnetik/class

Load class NelmioApiDocBundle annotations
nelmio · Apr 19, 2018 · 473a8cc · 473a8cc
2 parents 604ab3d + c90f2a1
commit 473a8cc
Show file tree

Hide file tree

Showing 4 changed files with 53 additions and 2 deletions.
diff --git a/Describer/SwaggerPhpDescriber.php b/Describer/SwaggerPhpDescriber.php
@@ -96,7 +96,17 @@ public function ref($ref)
             'head' => SWG\Head::class,
         ];
 
+        $classAnnotations = [];
+
         foreach ($this->getMethodsToParse() as $method => list($path, $httpMethods)) {
+            $declaringClass = $method->getDeclaringClass();
+            if (!array_key_exists($declaringClass->getName(), $classAnnotations)) {
+                $classAnnotations = array_filter($this->annotationReader->getClassAnnotations($declaringClass), function ($v) {
+                    return $v instanceof SWG\AbstractAnnotation;
+                });
+                $classAnnotations[$declaringClass->getName()] = $classAnnotations;
+            }
+
             $annotations = array_filter($this->annotationReader->getMethodAnnotations($method), function ($v) {
                 return $v instanceof SWG\AbstractAnnotation;
             });
@@ -105,7 +115,6 @@ public function ref($ref)
                 continue;
             }
 
-            $declaringClass = $method->getDeclaringClass();
             $context = new Context([
                 'namespace' => $method->getNamespaceName(),
                 'class' => $declaringClass->getShortName(),
@@ -117,7 +126,7 @@ public function ref($ref)
             $implicitAnnotations = [];
             $tags = [];
             $security = [];
-            foreach ($annotations as $annotation) {
+            foreach (array_merge($annotations, $classAnnotations[$declaringClass->getName()]) as $annotation) {
                 $annotation->_context = $context;
                 $this->updateNestedAnnotations($annotation, $nestedContext);
 

diff --git a/Tests/Functional/Controller/ClassApiController.php b/Tests/Functional/Controller/ClassApiController.php
@@ -0,0 +1,31 @@
+<?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\Tests\Functional\Controller;
+
+use Nelmio\ApiDocBundle\Annotation\Security;
+use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
+use Swagger\Annotations as SWG;
+
+/**
+ * @Route("/api", host="api.example.com")
+ * @Security(name="basic")
+ */
+class ClassApiController
+{
+    /**
+     * @Route("/security/class")
+     * @SWG\Response(response="201", description="")
+     */
+    public function securityAction()
+    {
+    }
+}
diff --git a/Tests/Functional/FunctionalTest.php b/Tests/Functional/FunctionalTest.php
@@ -276,6 +276,16 @@ public function testSecurityAction()
         $this->assertEquals($expected, $operation->getSecurity());
     }
 
+    public function testClassSecurityAction()
+    {
+        $operation = $this->getOperation('/api/security/class', 'get');
+
+        $expected = [
+            ['basic' => []],
+        ];
+        $this->assertEquals($expected, $operation->getSecurity());
+    }
+
     public function testSymfonyConstraintDocumentation()
     {
         $this->assertEquals([

diff --git a/Tests/Functional/TestKernel.php b/Tests/Functional/TestKernel.php
@@ -66,6 +66,7 @@ protected function configureRoutes(RouteCollectionBuilder $routes)
     {
         $routes->import(__DIR__.'/Controller/TestController.php', '/', 'annotation');
         $routes->import(__DIR__.'/Controller/ApiController.php', '/', 'annotation');
+        $routes->import(__DIR__.'/Controller/ClassApiController.php', '/', 'annotation');
         $routes->import(__DIR__.'/Controller/UndocumentedController.php', '/', 'annotation');
         $routes->import('', '/api', 'api_platform');
         $routes->add('/docs/{area}', 'nelmio_api_doc.controller.swagger_ui')->setDefault('area', 'default');