TouchInstinct
/
api-generator-templates
304
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

main concepts anchors added

This commit is contained in:
elena 2018-04-09 13:37:45 +03:00
parent a0ff5769ae
commit 6fa3d696cc
2 changed files with 23 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
Web-documentation/all_contents.html.twig
View File

@ -34,23 +34,23 @@
<ol>
<li>
<h2 class="numbered-contents__title">
<a href="index.html">Общие принципы построения API</a>
<a href="#main-concepts">Общие принципы построения API</a>
</h2>
<ol>
<li><a href="index.html">Протокол общения между сервером и клиентом</a></li>
<li><a href="index.html">Стиль построения API</a></li>
<li><a href="index.html">Используемая кодировка</a></li>
<li><a href="index.html">Допустимые задержки</a></li>
<li><a href="index.html">Передача параметров</a></li>
<li><a href="index.html">Перечисления</a></li>
<li><a href="index.html">Общий вид ответа сервера</a></li>
<li><a href="#main-concepts-protocol">Протокол общения между сервером и клиентом</a></li>
<li><a href="#main-concepts-style">Стиль построения API</a></li>
<li><a href="#main-concepts-encoding">Используемая кодировка</a></li>
<li><a href="#main-concepts-delay">Допустимые задержки</a></li>
<li><a href="#main-concepts-params">Передача параметров</a></li>
<li><a href="#main-concepts-enums">Перечисления</a></li>
<li><a href="#main-concepts-general-response">Общий вид ответа сервера</a></li>
</ol>
</li>
{% if versioningEnabled %}
<li>
<h2 class="numbered-contents__title">
<a href="index.html">Версионирование API</a>
<a href="#versioining">Версионирование API</a>
</h2>
<ol>
<li><a href="versioning.html">Описание</a></li>
@ -71,7 +71,7 @@
<div class="numbered-page-data">
<ol>
<li>
<h2 class="main-title">Общие принципы построения API</h2>
<h2 class="main-title" id="main-concepts">Общие принципы построения API</h2>
<ol>
<li>
{%- include 'blocks/main-concepts.html.twig' with { responseClass: responseClass } %}
@ -81,7 +81,7 @@
{% if versioningEnabled %}
<li>
<h2 class="main-title">Версионирование API</h2>
<h2 class="main-title" id="versioning">Версионирование API</h2>
<ol>
<li>
{%- include 'blocks/versioning-info.html.twig' with { errorType: errorType, errorsPagePath: errorsPagePath } %}

24
Web-documentation/blocks/main-concepts.html.twig
View File

@ -1,23 +1,23 @@
<div class="page-data">
<h2>Протокол общения между сервером и клиентом</h2>
<h2 id="main-concepts-protocol">Протокол общения между сервером и клиентом</h2>
<p class="sub-header">HTTPS</p>
<h2>Стиль построения API</h2>
<h2 id="main-concepts-style">Стиль построения API</h2>
<p class="sub-header">REST</p>
<h2>Используемая кодировка</h2>
<h2 id="main-concepts-encoding">Используемая кодировка</h2>
<p class="sub-header">UTF-8</p>
<h2>Допустимые задержки</h2>
<h2 id="main-concepts-delay">Допустимые задержки</h2>
<p class="sub-header">Генерация ответа на сервере в среднем занимает меньше 1 секунды.</p>
<h2>Передача параметров</h2>
<h2 id="main-concepts-params">Передача параметров</h2>
<p>Параметры передаются в виде JSON-объекта в теле запроса. Для всех запросов должен быть выставлен Content-Type: application/json.</p>
<h2>Перечисления</h2>
<h2 id="main-concepts-enums">Перечисления</h2>
<p class="sub-header">Перечисления в JSON-объектах передаются в виде типа string.</p>
<h2>Общий вид ответа сервера</h2>
<h2 id="main-concepts-general-response">Общий вид ответа сервера</h2>
<p>Результат вызова любого метода представляет собоий JSON-объект следующеий структуры:</p>
<div class="table">
<div class="part-table">
@ -28,11 +28,11 @@
<div>Обязательность</div>
</div>
{% for field in responseClass.fields -%}
{%- include 'field-row.html.twig' with {
field: field,
objectsLinks: objectsLinks
} %}
{%- endfor %}
{%- include 'field-row.html.twig' with {
field: field,
objectsLinks: objectsLinks
} %}
{% endfor %}
</div>
</div>
</div>