Add a config option for a default sandbox accept header

This commit is contained in:
Greg Holland 2012-12-11 17:59:03 -08:00
parent c946fbcf4f
commit fef40329a4
5 changed files with 27 additions and 0 deletions

View File

@ -39,6 +39,7 @@ class Configuration implements ConfigurationInterface
->children() ->children()
->scalarNode('enabled')->defaultTrue()->end() ->scalarNode('enabled')->defaultTrue()->end()
->scalarNode('endpoint')->defaultValue('/app_dev.php')->end() ->scalarNode('endpoint')->defaultValue('/app_dev.php')->end()
->scalarNode('accept_type')->defaultValue('')->end()
->arrayNode('request_format') ->arrayNode('request_format')
->addDefaultsIfNotSet() ->addDefaultsIfNotSet()
->children() ->children()

View File

@ -32,6 +32,7 @@ class NelmioApiDocExtension extends Extension
$container->setParameter('nelmio_api_doc.sandbox.enabled', $config['sandbox']['enabled']); $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.endpoint', $config['sandbox']['endpoint']);
$container->setParameter('nelmio_api_doc.sandbox.request_format.method', $config['sandbox']['request_format']['method']); $container->setParameter('nelmio_api_doc.sandbox.request_format.method', $config['sandbox']['request_format']['method']);
$container->setParameter('nelmio_api_doc.sandbox.accept_type', $config['sandbox']['accept_type']);
$container->setParameter('nelmio_api_doc.sandbox.request_format.default_format', $config['sandbox']['request_format']['default_format']); $container->setParameter('nelmio_api_doc.sandbox.request_format.default_format', $config['sandbox']['request_format']['default_format']);
$loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config')); $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));

View File

@ -45,6 +45,11 @@ class HtmlFormatter extends AbstractFormatter
*/ */
private $requestFormatMethod; private $requestFormatMethod;
/**
* @var string
*/
private $acceptType;
/** /**
* @var array * @var array
*/ */
@ -90,6 +95,14 @@ class HtmlFormatter extends AbstractFormatter
$this->engine = $engine; $this->engine = $engine;
} }
/**
* @param string $acceptType
*/
public function setAcceptType($acceptType)
{
$this->acceptType = $acceptType;
}
/** /**
* @param string $method * @param string $method
*/ */
@ -144,6 +157,7 @@ class HtmlFormatter extends AbstractFormatter
'endpoint' => $this->endpoint, 'endpoint' => $this->endpoint,
'enableSandbox' => $this->enableSandbox, 'enableSandbox' => $this->enableSandbox,
'requestFormatMethod' => $this->requestFormatMethod, 'requestFormatMethod' => $this->requestFormatMethod,
'acceptType' => $this->acceptType,
'defaultRequestFormat' => $this->defaultRequestFormat, 'defaultRequestFormat' => $this->defaultRequestFormat,
'date' => date(DATE_RFC822), 'date' => date(DATE_RFC822),
'css' => file_get_contents(__DIR__ . '/../Resources/public/css/screen.css'), 'css' => file_get_contents(__DIR__ . '/../Resources/public/css/screen.css'),

View File

@ -43,6 +43,9 @@
<call method="setDefaultRequestFormat"> <call method="setDefaultRequestFormat">
<argument>%nelmio_api_doc.sandbox.request_format.default_format%</argument> <argument>%nelmio_api_doc.sandbox.request_format.default_format%</argument>
</call> </call>
<call method="setAcceptType">
<argument>%nelmio_api_doc.sandbox.accept_type%</argument>
</call>
<call method="setAuthentication"> <call method="setAuthentication">
<argument>%nelmio_api_doc.sandbox.authentication%</argument> <argument>%nelmio_api_doc.sandbox.authentication%</argument>
</call> </call>

View File

@ -202,6 +202,14 @@
<fieldset class="headers"> <fieldset class="headers">
<legend>Headers</legend> <legend>Headers</legend>
{% if acceptType %}
<p class="tuple">
<input type="text" class="key" value="Accept" />
<span>=</span>
<input type="text" class="value" value="{{ acceptType }}" /> <span class="remove">-</span>
</p>
{% endif %}
<p class="tuple"> <p class="tuple">
<input type="text" class="key" placeholder="Key" /> <input type="text" class="key" placeholder="Key" />
<span>=</span> <span>=</span>