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

Make JSON declaration method configurable

Browse Source
This commit is contained in:
Vyacheslav Slinko 2012-10-16 23:41:16 +04:00
parent 6aac4a001e
commit 8e03ef99fa
5 changed files with 40 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
DependencyInjection/Configuration.php
View File

@ -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()

1
DependencyInjection/NelmioApiDocExtension.php
View File

@ -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');

28
Formatter/HtmlFormatter.php
View File

@ -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,
'authentication' => $this->authentication,
'endpoint' => $this->endpoint,
'enableSandbox' => $this->enableSandbox,
'date' => date(DATE_RFC822),
'css' => file_get_contents(__DIR__ . '/../Resources/public/css/screen.css'),
'js' => file_get_contents(__DIR__ . '/../Resources/public/js/all.js'),
'apiName' => $this->apiName,
'authentication' => $this->authentication,
'endpoint' => $this->endpoint,
'enableSandbox' => $this->enableSandbox,
'jsonDeclarationMethod' => $this->jsonDeclarationMethod,
'date' => date(DATE_RFC822),
'css' => file_get_contents(__DIR__ . '/../Resources/public/css/screen.css'),
'js' => file_get_contents(__DIR__ . '/../Resources/public/js/all.js'),
);
}

3
Resources/config/formatters.xml
View File

@ -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>

11
Resources/views/layout.html.twig
View File

@ -134,13 +134,18 @@
var url = $(this).attr('action'),
method = $(this).attr('method'),
self = this,
params = {
_format: 'json' // default format if not overriden in the form
},
params = {},
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;