files/ru/mdn/tools/unsupported_get_api/index.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101

---
title: URL-суффиксы
slug: MDN/Tools/Unsupported_GET_API
tags:
  - HTTP
  - Kuma
  - MDN Мета
  - URL
  - Параметры URL
  - инструменты
translation_of: MDN/Tools/Document_parameters
original_slug: MDN/Tools/URL-suffix
---
<div>{{MDNSidebar}}</div>

<section id="intro">
<p id="Introduction"><span class="seoSummary">Вики-платформа MDN Kuma не имеет центрального API. Вместо этого наш общий подход заключается в том, чтобы предложить способы превращения доступных для человека ресурсов в удобные для машин данные.</span></p>
</section>

<section id="params">
<h2 id="Параметры_URL_GET"><span class="VIiyi" lang="ru"><span class="ChMk0b JLqJ4b"><span>Параметры URL GET</span></span></span></h2>

<p><span class="VIiyi" lang="ru"><span class="ChMk0b JLqJ4b"><span>Мы поддерживаем несколько полезных параметров запроса для каждого URL-адреса вики-документа Kuma при получении через HTTP GET или просмотре в браузере.</span></span></span></p>

<p><span class="VIiyi" lang="ru"><span class="ChMk0b JLqJ4b"><span>Несколько параметров запроса разделяются знаком <kbd>&amp;</kbd> вместо начального <kbd>?</kbd>.</span></span> <span class="ChMk0b JLqJ4b"><span>(См. Примеры макроса.)</span></span></span></p>

<dl>
 <dt><code>summary</code></dt>
 <dd>
 <p><span class="VIiyi" lang="ru"><span class="ChMk0b JLqJ4b"><span>Указывает Куме возвращать только сводку страницы.</span></span> <span class="ChMk0b JLqJ4b"><span>Если на странице есть контент, помеченный классом «Сводка SEO», этот контент возвращается.</span></span> <span class="ChMk0b JLqJ4b"><span>Если такого содержания нет, возвращается содержание раздела «Сводка».</span></span> <span class="ChMk0b JLqJ4b"><span>В противном случае возвращается содержимое первого блока.</span></span></span></p>

 <div class="note"><strong><span class="VIiyi" lang="ru"><span class="ChMk0b JLqJ4b"><span>Уведомление об ошибке</span></span></span>:</strong> <span class="VIiyi" lang="ru"><span class="ChMk0b JLqJ4b"><span>В настоящее время существует ошибка, из-за которой сводный параметр возвращает весь документ, если вы также не укажете необработанный параметр.</span></span> <span class="ChMk0b JLqJ4b"><span>Обратите внимание, что вы также можете получить сводку из возвращенного JSON, <a href="/ru/docs/MDN/Tools/URL-suffix#json-view">используя альтернативное представление $ json</a>.</span></span></span></div>
 </dd>
 <dt><code>raw</code></dt>
 <dd><span class="VIiyi" lang="ru"><span class="ChMk0b JLqJ4b"><span>Указывает Kuma вернуть необработанное содержимое страницы без какого-либо материала обложки, такого как верхние, нижние колонтитулы и т. д.</span></span> <span class="ChMk0b JLqJ4b"><span>При этом не выполняются шаблоны или сценарии, что удобно для редакторов сборки.</span></span></span></dd>
 <dd><strong>Пример:</strong> <a href="https://wiki.developer.mozilla.org/ru/docs/HTML/HTML5?raw">https://wiki.developer.mozilla.org/ru/docs/HTML/HTML5?raw</a></dd>
 <dt><code>macros</code></dt>
 <dd><span class="VIiyi" lang="ru"><span class="ChMk0b JLqJ4b"><span>Поручает Kuma выполнить все шаблоны на странице.</span></span> <span class="ChMk0b JLqJ4b"><span>В сочетании с <code>?raw</code> это предлагает полностью визуализированный контент MDN без оболочки сайт</span></span></span> . <span class="VIiyi" lang="ru"><span class="ChMk0b JLqJ4b"><span>Поручает Kuma выполнить все шаблоны на странице.</span></span> <span class="ChMk0b JLqJ4b"><span>В сочетании с <code>?raw</code> это предлагает полностью визуализированный контент MDN без оболочки сайта.</span></span></span> <span class="VIiyi" lang="ru"><span class="ChMk0b JLqJ4b"><span>По умолчанию включено без  <code>?raw</code> (то есть при обычном просмотре сайта), по умолчанию выключено, когда присутствует <code>?raw</code>.</span></span></span></dd>
 <dd><strong>Пример:</strong> <a href="https://wiki.developer.mozilla.org/ru/docs/HTML/HTML5?raw&amp;macros">https://wiki.developer.mozilla.org/ru/docs/HTML/HTML5?raw&amp;macros</a></dd>
 <dt><code>nomacros</code></dt>
 <dd>
 <div class="J0lOec"><span class="VIiyi" lang="ru"><span class="ChMk0b JLqJ4b"><span>Указывает Kuma не выполнять шаблоны KumaScript на странице.</span></span> <span class="ChMk0b JLqJ4b"><span>Поскольку при обычном просмотре сайта для <code>?macros</code> по умолчанию установлено значение «включено», этот параметр отключает его.</span></span></span></div>
 </dd>
 <dd><strong>Пример:</strong> <a href="https://wiki.developer.mozilla.org/ru/docs/HTML/HTML5?nomacros">https://wiki.developer.mozilla.org/ru/docs/HTML/HTML5?nomacros</a></dd>
 <dt><code>include</code></dt>
 <dd><span class="VIiyi" lang="ru"><span class="ChMk0b JLqJ4b"><span>Говорит Kuma удалить все блоки, на которых есть класс <code>noinclude</code>.</span></span> <span class="ChMk0b JLqJ4b"><span>Это полезно для получения вывода таким, каким он был бы при включении на другую страницу, а не на отдельной странице.</span></span> <span class="ChMk0b JLqJ4b"><span>Часто это удаляет образец кода и тому подобное (хотя не всегда).</span></span></span></dd>
 <dd><strong>Пример:</strong> <a href="https://wiki.developer.mozilla.org/ru/docs/Archive/Mozilla/XUL/Attribute/align?raw&amp;macros&amp;include">https://wiki.developer.mozilla.org/ru/docs/Archive/Mozilla/XUL/Attribute/align?raw&amp;macros&amp;include</a></dd>
 <dt><code>section=id</code></dt>
 <dd><span class="VIiyi" lang="ru"><span class="ChMk0b JLqJ4b"><span>Указывает Kuma вернуть содержимое только из раздела с указанным якорем/именем привязки.</span></span></span></dd>
 <dd><strong>Пример:</strong>
 <ul>
  <li><a href="/ru/docs/MDN/Tools/URL-suffix?raw&amp;section=params">https://wiki.developer.mozilla.org/ru/docs/MDN/Tools/URL-suffix?raw&amp;section=params</a><br>
   (...и больше интересного...)</li>
  <li><a href="/ru/docs/MDN/Tools/URL-suffix?raw&amp;macros&amp;section=params">https://wiki.developer.mozilla.org/ru/docs/MDN/Tools/URL-suffix?raw&amp;macros&amp;section=params</a></li>
 </ul>

 <div class="note"><strong><span class="VIiyi" lang="ru"><span class="ChMk0b JLqJ4b"><span>Уведомление об ошибке</span></span></span>: </strong> <span class="VIiyi" lang="ru"><span class="ChMk0b JLqJ4b"><span>В настоящее время существует ошибка, из-за которой параметр</span></span></span> <code>section</code>  <span class="VIiyi" lang="ru"><span class="C1N51c ChMk0b JLqJ4b"><span>возвращает весь документ, если вы также не укажете параметр</span></span></span> <code>raw</code>.</div>
 </dd>
 <dt><code>expand</code></dt>
 <dd>
 <p><span class="VIiyi" lang="ru"><span class="ChMk0b JLqJ4b"><span>В сочетании с представлением <code>$children</code> расширяет ответ JSON с подробной информацией для каждой подстраницы.</span></span> <span class="ChMk0b JLqJ4b"><span>Он работает как комбинация <code>$children</code> и <code>$json</code> на каждой подстранице.</span></span> <span class="ChMk0b JLqJ4b"><span>Таким образом, можно узнать о тегах для подстраницы.</span></span></span></p>

 <p><strong>Пример:</strong> <a href="/ru/docs/MDN/About$children?expand">https://wiki.developer.mozilla.org/ru/docs/MDN/About$children?expand</a></p>
 </dd>
</dl>
</section>

<section id="metadata">
<h2 id="Ресурсы_метаданных_документа"><span class="VIiyi" lang="ru"><span class="ChMk0b JLqJ4b"><span>Ресурсы метаданных документа</span></span></span></h2>

<p>Наряду с параметрами для настройки ответа URL-адреса документа существуют также некоторые альтернативные представления документов, заданные суффиксом URL-адреса:</p>

<dl>
 <dt><code>$toc</code></dt>
 <dd><span class="VIiyi" lang="ru"><span class="ChMk0b JLqJ4b"><span>Указывает Kuma вернуть только оглавление страницы в HTML.</span></span> <span class="ChMk0b JLqJ4b"><span>Он возвращается как упорядоченный список (то есть</span></span></span> , {{HTMLElement("ol")}}).</dd>
 <dd><strong>Пример:</strong> <a href="https://wiki.developer.mozilla.org/ru/docs/MDN/Tools/URL-suffix$toc">https://wiki.developer.mozilla.org/ru/docs/MDN/Tools/URL-suffix$toc</a></dd>
 <dt id="json-view"><code>$json</code></dt>
 <dd><span class="VIiyi" lang="ru"><span class="ChMk0b JLqJ4b"><span>Сообщает Kuma описать страницу в объекте JSON.</span></span> <span class="ChMk0b JLqJ4b"><span>Этот объект по сути тот же, что и при использовании подпрограммы KumaScript <code>wiki.getPage()</code>.</span></span></span></dd>
 <dd><strong>Пример:</strong> <a href="/ru/docs/MDN/About$json">https://wiki.developer.mozilla.org/ru/docs/MDN/About$json</a></dd>
 <dt><code>$children</code></dt>
 <dd><span class="VIiyi" lang="ru"><span class="ChMk0b JLqJ4b"><span>Говорит Kuma перечислить дочерние темы страницы в JSON.</span></span> <span class="ChMk0b JLqJ4b"><span>Этот объект по сути тот же, что и при использовании подпрограммы KumaScript</span></span></span> <code>pages.subpages()</code>.</dd>
 <dd><strong>Пример:</strong> <a href="/ru/docs/MDN/Contribute$children">https://wiki.developer.mozilla.org/ru/docs/MDN/Contribute$children</a></dd>
 <dd>
 <div class="J0lOec"><span class="VIiyi" lang="ru"><span class="ChMk0b JLqJ4b"><span>(<code>М</code>ожно использовать с параметром <code>?expand</code> для получения более подробного ответа.)</span></span></span></div>
 </dd>
 <dt><code>$compare</code></dt>
 <dd>
 <p>Представляет различия строк исходного текста между ревизиями, указанными в требуемых параметрах запроса <code>?from</code> и <code>?to</code>.</p>
 </dd>
 <dd><strong>Пример:</strong> <a href="/ru/docs/Web/API/KeyboardEvent/key/Key_Values$compare?locale=ru&amp;to=1651013&amp;from=1650680">https://wiki.developer.mozilla.org/ru/docs/Web/API/KeyboardEvent/key/Key_Values$compare?locale=ru&amp;to=1651013&amp;from=1650680</a></dd>
 <dt><code>$edit</code></dt>
 <dd><span class="VIiyi" lang="ru"><span class="ChMk0b JLqJ4b"><span>Редактирует текущую ревизию данного документа вместо его отображения.</span></span></span></dd>
 <dd><strong>Пример:</strong> <a href="/ru/docs/MDN/Tools/URL-suffix$edit">https://wiki.developer.mozilla.org/ru/docs/MDN/Tools/URL-suffix$edit</a></dd>
 <dt><code>$history</code></dt>
 <dd><span class="VIiyi" lang="ru"><span class="ChMk0b JLqJ4b"><span>Показывает историю последних десяти ревизий данного документа вместо его содержимого.</span></span> <span class="ChMk0b JLqJ4b"><span>Полную историю можно запросить с помощью значения параметра запроса <code>?limit=all</code>.</span></span></span></dd>
 <dd><strong>Пример:</strong> <a href="/ru/docs/MDN/Tools/URL-suffix$history?limit=all">https://wiki.developer.mozilla.org/ru/docs/MDN/Tools/URL-suffix$history?limit=all</a></dd>
 <dt><code>$revision</code></dt>
 <dd><span class="VIiyi" lang="ru"><span class="ChMk0b JLqJ4b"><span>Отображает номер ревизии документа, который необходимо указать после разделителя «/».</span></span></span></dd>
 <dd><strong>Пример:</strong> <a href="/ru/docs/MDN/Tools/URL-suffix$revision/1652169">https://wiki.developer.mozilla.org/ru/docs/MDN/Tools/URL-suffix$revision/1652169</a></dd>
</dl>
</section>