mirror of
https://github.com/retailcrm/NelmioApiDocBundle.git
synced 2025-02-02 15:51:48 +03:00
577 lines
24 KiB
Twig
577 lines
24 KiB
Twig
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<!-- Always force latest IE rendering engine (even in intranet) and Chrome Frame -->
|
|
<meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible" />
|
|
<title>{{ apiName }}</title>
|
|
<style type="text/css">
|
|
{{ css|raw }}
|
|
</style>
|
|
<script type="text/javascript">
|
|
{{ js|raw }}
|
|
</script>
|
|
</head>
|
|
<body>
|
|
<div id="header">
|
|
<a href="{{ path('nelmio_api_doc_index') }}"><h1>{{ apiName }}</h1></a>
|
|
{% if enableSandbox %}
|
|
<div id="sandbox_configuration">
|
|
{% if bodyFormats|length > 0 %}
|
|
body format:
|
|
<select id="body_format">
|
|
{% if 'form' in bodyFormats %}<option value="form"{{ defaultBodyFormat == 'form' ? ' selected' : '' }}>Form Data</option>{% endif %}
|
|
{% if 'json' in bodyFormats %}<option value="json"{{ defaultBodyFormat == 'json' ? ' selected' : '' }}>JSON</option>{% endif %}
|
|
</select>
|
|
{% endif %}
|
|
request format:
|
|
<select id="request_format">
|
|
{% for format, header in requestFormats %}
|
|
<option value="{{ header }}"{{ defaultRequestFormat == format ? ' selected' : '' }}>{{ format }}</option>
|
|
{% endfor %}
|
|
</select>
|
|
{% if authentication and authentication.delivery in ['query', 'http_basic', 'header'] %}
|
|
api key: <input type="text" id="api_key" value=""/>
|
|
{% endif %}
|
|
{% if authentication and authentication.delivery in ['http_basic'] %}
|
|
api pass: <input type="text" id="api_pass" value=""/>
|
|
{% endif %}
|
|
{% if authentication and authentication.custom_endpoint %}
|
|
api endpoint: <input type="text" id="api_endpoint" value=""/>
|
|
{% endif %}
|
|
</div>
|
|
{% endif %}
|
|
<br style="clear: both;" />
|
|
</div>
|
|
{% include motdTemplate %}
|
|
<div class="container" id="resources_container">
|
|
<ul id="resources">
|
|
{% block content %}{% endblock %}
|
|
</ul>
|
|
</div>
|
|
<p id="colophon">
|
|
Documentation auto-generated on {{ date }}
|
|
</p>
|
|
<script type="text/javascript">
|
|
|
|
var getHash = function() {
|
|
return window.location.hash || '';
|
|
};
|
|
|
|
var setHash = function(hash) {
|
|
window.location.hash = hash;
|
|
};
|
|
|
|
var clearHash = function() {
|
|
var scrollTop, scrollLeft;
|
|
|
|
if(typeof history === 'object' && typeof history.pushState === 'function') {
|
|
history.replaceState('', document.title, window.location.pathname + window.location.search);
|
|
} else {
|
|
scrollTop = document.body.scrollTop;
|
|
scrollLeft = document.body.scrollLeft;
|
|
|
|
setHash('');
|
|
|
|
document.body.scrollTop = scrollTop;
|
|
document.body.scrollLeft = scrollLeft;
|
|
}
|
|
};
|
|
|
|
$(window).load(function() {
|
|
var id = getHash().substr(1).replace( /([:\.\[\]\{\}])/g, "\\$1");
|
|
var elem = $('#' + id);
|
|
if (elem.length) {
|
|
setTimeout(function() {
|
|
$('body,html').scrollTop(elem.position().top);
|
|
});
|
|
elem.find('.toggler').click();
|
|
}
|
|
});
|
|
|
|
$('.toggler').click(function(event) {
|
|
var contentContainer = $(this).next();
|
|
|
|
if(contentContainer.is(':visible')) {
|
|
clearHash();
|
|
} else {
|
|
setHash($(this).data('href'));
|
|
}
|
|
|
|
contentContainer.slideToggle('fast');
|
|
return false;
|
|
});
|
|
|
|
{% if enableSandbox %}
|
|
var setParameterType = function ($context,setType) {
|
|
// no 2nd argument, use default from parameters
|
|
if (typeof setType == "undefined") {
|
|
setType = $context.parent().attr("data-dataType");
|
|
$context.val(setType);
|
|
}
|
|
|
|
$context.parent().find('.value').remove();
|
|
var placeholder = "";
|
|
if ($context.parent().attr("data-dataType") != "" && typeof $context.parent().attr("data-dataType") != "undefined") {
|
|
placeholder += "[" + $context.parent().attr("data-dataType") + "] ";
|
|
}
|
|
if ($context.parent().attr("data-format") != "" && typeof $context.parent().attr("data-format") != "undefined") {
|
|
placeholder += $context.parent().attr("data-dataType");
|
|
}
|
|
if ($context.parent().attr("data-description") != "" && typeof $context.parent().attr("data-description") != "undefined") {
|
|
placeholder += $context.parent().attr("data-description");
|
|
} else {
|
|
placeholder += "Value";
|
|
}
|
|
|
|
switch(setType) {
|
|
case "boolean":
|
|
$('<select class="value"><option value=""></option><option value="1">True</option><option value="0">False</option></select>').insertAfter($context);
|
|
break;
|
|
case "file":
|
|
$('<input type="file" class="value" placeholder="'+ placeholder +'">').insertAfter($context);
|
|
break;
|
|
default:
|
|
$('<input type="text" class="value" placeholder="'+ placeholder +'">').insertAfter($context);
|
|
}
|
|
};
|
|
|
|
var toggleButtonText = function ($btn) {
|
|
if ($btn.text() === 'Default') {
|
|
$btn.text('Raw');
|
|
} else {
|
|
$btn.text('Default');
|
|
}
|
|
};
|
|
|
|
var renderRawBody = function ($container) {
|
|
var rawData, $btn;
|
|
|
|
rawData = $container.data('raw-response');
|
|
$btn = $container.parents('.pane').find('.to-raw');
|
|
|
|
$container.addClass('prettyprinted');
|
|
$container.html($('<div/>').text(rawData).html());
|
|
|
|
$btn.removeClass('to-raw');
|
|
$btn.addClass('to-prettify');
|
|
|
|
toggleButtonText($btn);
|
|
};
|
|
|
|
var renderPrettifiedBody = function ($container) {
|
|
var rawData, $btn;
|
|
|
|
rawData = $container.data('raw-response');
|
|
$btn = $container.parents('.pane').find('.to-prettify');
|
|
|
|
$container.removeClass('prettyprinted');
|
|
$container.html(prettifyResponse(rawData));
|
|
prettyPrint && prettyPrint();
|
|
|
|
$btn.removeClass('to-prettify');
|
|
$btn.addClass('to-raw');
|
|
|
|
toggleButtonText($btn);
|
|
};
|
|
|
|
var unflattenDict = function (body) {
|
|
var found = true;
|
|
while(found) {
|
|
found = false;
|
|
|
|
for (var key in body) {
|
|
var okey;
|
|
var value = body[key];
|
|
var dictMatch = key.match(/^(.+)\[([^\]]+)\]$/);
|
|
|
|
if(dictMatch) {
|
|
found = true;
|
|
okey = dictMatch[1];
|
|
var subkey = dictMatch[2];
|
|
body[okey] = body[okey] || {};
|
|
body[okey][subkey] = value;
|
|
delete body[key];
|
|
} else {
|
|
body[key] = value;
|
|
}
|
|
}
|
|
}
|
|
return body;
|
|
}
|
|
|
|
$('.tabs li').click(function() {
|
|
var contentGroup = $(this).parents('.content');
|
|
|
|
$('.pane.selected', contentGroup).removeClass('selected');
|
|
$('.pane.' + $(this).data('pane'), contentGroup).addClass('selected');
|
|
|
|
$('li', $(this).parent()).removeClass('selected');
|
|
$(this).addClass('selected');
|
|
});
|
|
|
|
var prettifyResponse = function(text) {
|
|
try {
|
|
var data = typeof text === 'string' ? JSON.parse(text) : text;
|
|
text = JSON.stringify(data, undefined, ' ');
|
|
} catch (err) {
|
|
}
|
|
|
|
// HTML encode the result
|
|
return $('<div>').text(text).html();
|
|
};
|
|
|
|
var displayFinalUrl = function(xhr, method, url, container) {
|
|
container.text(method + ' ' + url);
|
|
};
|
|
|
|
var displayProfilerUrl = function(xhr, link, container) {
|
|
var profilerUrl = xhr.getResponseHeader('X-Debug-Token-Link');
|
|
if (profilerUrl) {
|
|
link.attr('href', profilerUrl);
|
|
container.show();
|
|
} else {
|
|
link.attr('href', '');
|
|
container.hide();
|
|
}
|
|
}
|
|
|
|
var displayResponseData = function(xhr, container) {
|
|
var data = xhr.responseText;
|
|
|
|
container.data('raw-response', data);
|
|
|
|
renderPrettifiedBody(container);
|
|
|
|
container.parents('.pane').find('.to-prettify').text('Raw');
|
|
container.parents('.pane').find('.to-raw').text('Raw');
|
|
};
|
|
|
|
var displayResponseHeaders = function(xhr, container) {
|
|
var text = xhr.status + ' ' + xhr.statusText + "\n\n";
|
|
text += xhr.getAllResponseHeaders();
|
|
|
|
container.text(text);
|
|
};
|
|
|
|
var displayResponse = function(xhr, method, url, result_container) {
|
|
displayFinalUrl(xhr, method, url, $('.url', result_container));
|
|
displayProfilerUrl(xhr, $('.profiler-link', result_container), $('.profiler', result_container));
|
|
displayResponseData(xhr, $('.response', result_container));
|
|
displayResponseHeaders(xhr, $('.headers', result_container));
|
|
|
|
result_container.show();
|
|
};
|
|
|
|
$('.pane.sandbox form').submit(function() {
|
|
var url = $(this).attr('action'),
|
|
method = $(this).attr('method'),
|
|
self = this,
|
|
params = {},
|
|
formData = new FormData(),
|
|
doubledParams = {},
|
|
headers = {},
|
|
content = $(this).find('textarea.content').val(),
|
|
result_container = $('.result', $(this).parent());
|
|
|
|
if (method === 'ANY') {
|
|
method = 'POST';
|
|
} else if (method.indexOf('|') !== -1) {
|
|
method = method.split('|').sort().pop();
|
|
}
|
|
|
|
// set requestFormat
|
|
var requestFormatMethod = '{{ requestFormatMethod }}';
|
|
if (requestFormatMethod == 'format_param') {
|
|
params['_format'] = $('#request_format option:selected').text();
|
|
formData.append('_format',$('#request_format option:selected').text());
|
|
} else if (requestFormatMethod == 'accept_header') {
|
|
headers['Accept'] = $('#request_format').val();
|
|
}
|
|
|
|
// set default bodyFormat
|
|
var bodyFormat = $('#body_format').val() || '{{ defaultBodyFormat }}';
|
|
|
|
if(!('Content-type' in headers)) {
|
|
if (bodyFormat == 'form') {
|
|
headers['Content-type'] = 'application/x-www-form-urlencoded';
|
|
} else {
|
|
headers['Content-type'] = 'application/json';
|
|
}
|
|
}
|
|
|
|
var hasFileTypes = false;
|
|
$('.parameters .tuple_type', $(this)).each(function() {
|
|
if ($(this).val() == 'file') {
|
|
hasFileTypes = true;
|
|
}
|
|
});
|
|
|
|
if (hasFileTypes && method != 'POST') {
|
|
alert("Sorry, you can only submit files via POST.");
|
|
return false;
|
|
}
|
|
|
|
if (hasFileTypes) {
|
|
// retrieve all the parameters to send for file upload
|
|
$('.parameters .tuple', $(this)).each(function() {
|
|
var key, value;
|
|
|
|
key = $('.key', $(this)).val();
|
|
if ($('.value', $(this)).attr('type') === 'file' ) {
|
|
value = $('.value', $(this)).prop('files')[0];
|
|
} else {
|
|
value = $('.value', $(this)).val();
|
|
}
|
|
|
|
if (value) {
|
|
formData.append(key,value);
|
|
}
|
|
});
|
|
}
|
|
|
|
|
|
// retrieve all the parameters to send
|
|
$('.parameters .tuple', $(this)).each(function() {
|
|
var key, value;
|
|
|
|
key = $('.key', $(this)).val();
|
|
value = $('.value', $(this)).val();
|
|
|
|
if (value) {
|
|
// temporary save all additional/doubled parameters
|
|
if (key in params) {
|
|
doubledParams[key] = value;
|
|
} else {
|
|
params[key] = value;
|
|
}
|
|
}
|
|
});
|
|
|
|
|
|
|
|
|
|
|
|
// retrieve the additional headers to send
|
|
$('.headers .tuple', $(this)).each(function() {
|
|
var key, value;
|
|
|
|
key = $('.key', $(this)).val();
|
|
value = $('.value', $(this)).val();
|
|
|
|
if (value) {
|
|
headers[key] = value;
|
|
}
|
|
|
|
});
|
|
|
|
// fix parameters in URL
|
|
for (var key in $.extend({}, params)) {
|
|
if (url.indexOf('{' + key + '}') !== -1) {
|
|
url = url.replace('{' + key + '}', params[key]);
|
|
delete params[key];
|
|
}
|
|
};
|
|
|
|
// merge additional params back to real params object
|
|
if (!$.isEmptyObject(doubledParams)) {
|
|
$.extend(params, doubledParams);
|
|
}
|
|
|
|
// disable all the fiels and buttons
|
|
$('input, button', $(this)).attr('disabled', 'disabled');
|
|
|
|
// append the query authentication
|
|
if (authentication_delivery == 'query') {
|
|
url += url.indexOf('?') > 0 ? '&' : '?';
|
|
url += api_key_parameter + '=' + $('#api_key').val();
|
|
}
|
|
|
|
// prepare the api enpoint
|
|
{% if endpoint == '' and app.request is not null and app.request.host -%}
|
|
var endpoint = '{{ app.request.getBaseUrl() }}';
|
|
{% else -%}
|
|
var endpoint = '{{ endpoint }}';
|
|
{% endif -%}
|
|
if ($('#api_endpoint') && $('#api_endpoint').val() != null) {
|
|
endpoint = $('#api_endpoint').val();
|
|
}
|
|
|
|
// Workaround for Firefox bug and a thereby resulting nginx incompatibility
|
|
if (method == "LINK") {
|
|
method = "POST";
|
|
params._method = "LINK";
|
|
}
|
|
|
|
// prepare final parameters
|
|
var body = {};
|
|
if(bodyFormat == 'json' && method != 'GET') {
|
|
body = unflattenDict(params);
|
|
body = JSON.stringify(body);
|
|
} else {
|
|
body = params;
|
|
}
|
|
var data = content.length ? content : body;
|
|
var ajaxOptions = {
|
|
url: endpoint + url,
|
|
type: method,
|
|
data: data,
|
|
headers: headers,
|
|
crossDomain: true,
|
|
beforeSend: function (xhr) {
|
|
if (authentication_delivery == 'http_basic') {
|
|
xhr.setRequestHeader('Authorization', 'Basic ' + btoa($('#api_key').val() + ':' + $('#api_pass').val()));
|
|
}else if(authentication_delivery == 'header') {
|
|
xhr.setRequestHeader(api_key_parameter, $('#api_key').val());
|
|
}
|
|
},
|
|
complete: function(xhr) {
|
|
displayResponse(xhr, method, url, result_container);
|
|
|
|
// and enable them back
|
|
$('input:not(.content-type), button', $(self)).removeAttr('disabled');
|
|
}
|
|
};
|
|
|
|
// overrides body format to send data properly
|
|
if (hasFileTypes) {
|
|
ajaxOptions.data = formData;
|
|
ajaxOptions.processData = false;
|
|
ajaxOptions.contentType = false;
|
|
delete(ajaxOptions.headers);
|
|
}
|
|
|
|
// and trigger the API call
|
|
$.ajax(ajaxOptions);
|
|
|
|
return false;
|
|
});
|
|
|
|
$('.operations').on('click', '.operation > .heading', function(e) {
|
|
if (history.pushState) {
|
|
history.pushState(null, null, $(this).data('href'));
|
|
e.preventDefault();
|
|
}
|
|
});
|
|
|
|
$('.pane.sandbox').on('click', '.to-raw', function(e) {
|
|
renderRawBody($(this).parents('.pane').find('.response'));
|
|
|
|
e.preventDefault();
|
|
});
|
|
|
|
$('.pane.sandbox').on('click', '.to-prettify', function(e) {
|
|
renderPrettifiedBody($(this).parents('.pane').find('.response'));
|
|
|
|
e.preventDefault();
|
|
});
|
|
|
|
$('.pane.sandbox').on('click', '.to-expand, .to-shrink', function(e) {
|
|
var $headers = $(this).parents('.result').find('.headers');
|
|
var $label = $(this).parents('.result').find('a.to-expand');
|
|
|
|
if ($headers.hasClass('to-expand')) {
|
|
$headers.removeClass('to-expand');
|
|
$headers.addClass('to-shrink');
|
|
$label.text('Shrink');
|
|
} else {
|
|
$headers.removeClass('to-shrink');
|
|
$headers.addClass('to-expand');
|
|
$label.text('Expand');
|
|
}
|
|
|
|
e.preventDefault();
|
|
});
|
|
|
|
|
|
// sets the correct parameter type on load
|
|
$('.pane.sandbox .tuple_type').each(function() {
|
|
setParameterType($(this));
|
|
});
|
|
|
|
|
|
// handles parameter type change
|
|
$('.pane.sandbox').on('change', '.tuple_type', function() {
|
|
setParameterType($(this),$(this).val());
|
|
});
|
|
|
|
|
|
|
|
$('.pane.sandbox').on('click', '.add_parameter', function() {
|
|
var html = $(this).parents('.pane').find('.parameters_tuple_template').html();
|
|
|
|
$(this).before(html);
|
|
|
|
return false;
|
|
});
|
|
|
|
$('.pane.sandbox').on('click', '.add_header', function() {
|
|
var html = $(this).parents('.pane').find('.headers_tuple_template').html();
|
|
|
|
$(this).before(html);
|
|
|
|
return false;
|
|
});
|
|
|
|
$('.pane.sandbox').on('click', '.remove', function() {
|
|
$(this).parent().remove();
|
|
});
|
|
|
|
$('.pane.sandbox').on('click', '.set-content-type', function(e) {
|
|
var html;
|
|
var $element;
|
|
var $headers = $(this).parents('form').find('.headers');
|
|
var content_type = $(this).prev('input.value').val();
|
|
|
|
e.preventDefault();
|
|
|
|
if (content_type.length === 0) {
|
|
return;
|
|
}
|
|
|
|
$headers.find('input.key').each(function() {
|
|
if ($.trim($(this).val().toLowerCase()) === 'content-type') {
|
|
$element = $(this).parents('p');
|
|
return false;
|
|
}
|
|
});
|
|
|
|
if (typeof $element === 'undefined') {
|
|
html = $(this).parents('.pane').find('.tuple_template').html();
|
|
|
|
$element = $headers.find('legend').after(html).next('p');
|
|
}
|
|
|
|
$element.find('input.key').val('Content-Type');
|
|
$element.find('input.value').val(content_type);
|
|
|
|
});
|
|
|
|
{% if authentication and authentication.delivery == 'http_basic' %}
|
|
var authentication_delivery = '{{ authentication.delivery }}';
|
|
{% elseif authentication and authentication.delivery == 'query' %}
|
|
var authentication_delivery = '{{ authentication.delivery }}';
|
|
var api_key_parameter = '{{ authentication.name }}';
|
|
var search = window.location.search;
|
|
var api_key_start = search.indexOf(api_key_parameter) + api_key_parameter.length + 1;
|
|
|
|
if (api_key_start > 0 ) {
|
|
var api_key_end = search.indexOf('&', api_key_start);
|
|
|
|
var api_key = -1 == api_key_end
|
|
? search.substr(api_key_start)
|
|
: search.substring(api_key_start, api_key_end);
|
|
|
|
$('#api_key').val(api_key);
|
|
}
|
|
{% elseif authentication and authentication.delivery == 'header' %}
|
|
var authentication_delivery = '{{ authentication.delivery }}';
|
|
var api_key_parameter = '{{ authentication.name }}';
|
|
{% else %}
|
|
var authentication_delivery = false;
|
|
{% endif %}
|
|
{% endif %}
|
|
</script>
|
|
</body>
|
|
</html>
|