Set documentation endpoint type to all endpoints

Author: jdeniau

features/security/validate_incoming_content-types.feature

@@ -13,4 +13,4 @@ Feature: Validate incoming content type
     """
     Then the response status code should be 406
     And the header "Content-Type" should be equal to "application/ld+json; charset=utf-8"
-    And the JSON node "hydra:description" should be equal to 'The content-type "text/plain" is not supported. Supported MIME types are "application/ld+json", "application/hal+json", "application/vnd.api+json", "application/xml", "text/xml", "application/json", "text/html".'
+    And the JSON node "hydra:description" should be equal to 'The content-type "text/plain" is not supported. Supported MIME types are "application/ld+json", "application/hal+json", "application/vnd.api+json", "application/xml", "text/xml", "application/json".'

src/Bridge/Symfony/Bundle/EventListener/SwaggerUiListener.php

@@ -34,4 +34,10 @@ public function onKernelRequest(GetResponseEvent $event)
 
         $request->attributes->set('_controller', 'api_platform.swagger.action.ui');
     }
+
+    public function addEndpointTypeToRequest(GetResponseEvent $event)
+    {
+        $request = $event->getRequest();
+        $request->attributes->set('_api_endpoint_type', 'documentation');
+    }
 }

src/Bridge/Symfony/Bundle/Resources/config/routing/docs.xml

@@ -8,6 +8,7 @@
     <route id="api_doc" path="/docs.{_format}">
         <default key="_controller">api_platform.action.documentation</default>
         <default key="_api_respond">1</default>
+        <default key="_api_endpoint_type">documentation</default>
         <default key="_format" />
     </route>
 

src/Bridge/Symfony/Bundle/Resources/config/swagger-ui.xml

@@ -7,7 +7,8 @@
     <services>
 
         <service id="api_platform.swagger.listener.ui" class="ApiPlatform\Core\Bridge\Symfony\Bundle\EventListener\SwaggerUiListener">
-            <tag name="kernel.event_listener" event="kernel.request" method="onKernelRequest" />
+            <tag name="kernel.event_listener" event="kernel.request" method="addEndpointTypeToRequest" priority="8" />
+            <tag name="kernel.event_listener" event="kernel.request" method="onKernelRequest" priority="0" />
         </service>
 
     </services>

src/EventListener/AddFormatListener.php

@@ -88,7 +88,7 @@ public function onKernelRequest(GetResponseEvent $event)
                 return;
             }
 
-            throw $this->getNotAcceptableHttpException($mimeType);
+            throw $this->getNotAcceptableHttpException($mimeType ?? $requestFormat);
         }
 
         // Finally, if no Accept header nor Symfony request format is set, return the default format

tests/EventListener/AddFormatListenerTest.php

@@ -204,7 +204,7 @@ public function testSupportedDocumentationAcceptHeader()
 
     /**
      * @expectedException \Symfony\Component\HttpKernel\Exception\NotAcceptableHttpException
-     * @expectedExceptionMessage Requested format "application/ld+json" is not supported. Supported MIME types are "application/json".
+     * @expectedExceptionMessageRegExp /^Requested format "(jsonld|application\/ld\+json)" is not supported. Supported MIME types are "application\/json".$/
      */
     public function testUnsupportedDocumentationRequestFormat()
     {

tests/Fixtures/app/config/config_test.yml

@@ -33,6 +33,12 @@ api_platform:
         jsonapi:                       ['application/vnd.api+json']
         xml:                           ['application/xml', 'text/xml']
         json:                          ['application/json']
+    documentation_formats:
+        jsonld:                        ['application/ld+json']
+        jsonhal:                       ['application/hal+json']
+        jsonapi:                       ['application/vnd.api+json']
+        xml:                           ['application/xml', 'text/xml']
+        json:                          ['application/json']
         html:                          ['text/html']
     error_formats:
         jsonproblem:                   ['application/problem+json']