Make JSON declaration method configurable

DependencyInjection/Configuration.php

@@ -28,6 +28,13 @@ class Configuration implements ConfigurationInterface
                     ->children()
                         ->scalarNode('enabled')->defaultTrue()->end()
                         ->scalarNode('endpoint')->defaultValue('/app_dev.php')->end()
+                        ->scalarNode('json_declaration_method')
+                            ->defaultValue('format_param')
+                            ->validate()
+                                ->ifNotInArray(array('format_param', 'accept_header'))
+                                ->thenInvalid("Unknown json declaration method '%s'.")
+                            ->end()
+                        ->end()
                         ->arrayNode('authentication')
                             ->children()
                                 ->scalarNode('name')->isRequired()->end()

DependencyInjection/NelmioApiDocExtension.php

@@ -31,6 +31,7 @@ class NelmioApiDocExtension extends Extension
         $container->setParameter('nelmio_api_doc.api_name', $config['name']);
         $container->setParameter('nelmio_api_doc.sandbox.enabled',  $config['sandbox']['enabled']);
         $container->setParameter('nelmio_api_doc.sandbox.endpoint', $config['sandbox']['endpoint']);
+        $container->setParameter('nelmio_api_doc.sandbox.json_declaration_method', $config['sandbox']['json_declaration_method']);
 
         $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
         $loader->load('formatters.xml');

Formatter/HtmlFormatter.php

@@ -40,6 +40,11 @@ class HtmlFormatter extends AbstractFormatter
      */
     private $engine;
 
+    /**
+     * @var string
+     */
+    private $jsonDeclarationMethod;
+
     /**
      * @param array $authentication
      */
@@ -80,6 +85,14 @@ class HtmlFormatter extends AbstractFormatter
         $this->engine = $engine;
     }
 
+    /**
+     * @param string $method
+     */
+    public function setJsonDeclarationMethod($method)
+    {
+        $this->jsonDeclarationMethod = $method;
+    }
+
     /**
      * {@inheritdoc}
      */
@@ -133,13 +146,14 @@ class HtmlFormatter extends AbstractFormatter
     private function getGlobalVars()
     {
         return array(
-            'apiName'        => $this->apiName,
+            'apiName'               => $this->apiName,
-            'authentication' => $this->authentication,
+            'authentication'        => $this->authentication,
-            'endpoint'       => $this->endpoint,
+            'endpoint'              => $this->endpoint,
-            'enableSandbox'  => $this->enableSandbox,
+            'enableSandbox'         => $this->enableSandbox,
-            'date'           => date(DATE_RFC822),
+            'jsonDeclarationMethod' => $this->jsonDeclarationMethod,
-            'css'            => file_get_contents(__DIR__ . '/../Resources/public/css/screen.css'),
+            'date'                  => date(DATE_RFC822),
-            'js'             => file_get_contents(__DIR__ . '/../Resources/public/js/all.js'),
+            'css'                   => file_get_contents(__DIR__ . '/../Resources/public/css/screen.css'),
+            'js'                    => file_get_contents(__DIR__ . '/../Resources/public/js/all.js'),
         );
     }
 

Resources/config/formatters.xml

@@ -37,6 +37,9 @@
             <call method="setEndpoint">
                 <argument>%nelmio_api_doc.sandbox.endpoint%</argument>
             </call>
+            <call method="setJsonDeclarationMethod">
+                <argument>%nelmio_api_doc.sandbox.json_declaration_method%</argument>
+            </call>
             <call method="setAuthentication">
                 <argument>%nelmio_api_doc.sandbox.authentication%</argument>
             </call>

Resources/views/layout.html.twig

@@ -134,13 +134,18 @@
                     var url = $(this).attr('action'),
                         method = $(this).attr('method'),
                         self = this,
-                        params = {
+                        params = {},
-                            _format: 'json' // default format if not overriden in the form
-                        },
                         headers = {},
                         content = $(this).find('textarea.content').val();
                         result_container = $('.result', $(this).parent());
 
+                    var jsonDeclarationMethod = '{{ jsonDeclarationMethod }}';
+                    if (jsonDeclarationMethod == 'format_param') {
+                        params['_format'] = 'json';
+                    } else if (jsonDeclarationMethod == 'accept_header') {
+                        headers['Accept'] = 'application/json';
+                    }
+
                     // retrieve all the parameters to send
                     $('.parameters .tuple', $(this)).each(function() {
                     var key, value;