URL 引数と文書メタデータ

MDN の Kuma Wiki プラットホームには、外からアクセスする API がありません。代わりに、人間がアクセスできるリソースを機械的に扱いやすいデータに変換する手段を提供するというのが私たちのアプローチです。

URL 引数

すべての Kuma wiki 文書の URL が HTTP GET で取得されたりブラウザーで見られる時に役立つクエリ引数オプションをサポートしています。複数のクエリ引数は最初の ? の代わりに & で区切られます (マクロの例を見てください)。

summary

Kuma にページの概要のみを返すよう指示します。 "SEO summary" クラスでマークされたコンテンツがある場合、そのコンテンツが返されます。そのようなコンテンツがない場合、 "Summary" というタイトルのあるコンテンツが返されます。そうならない場合、最初のブロックのコンテンツが返されます。

メモ: 現在、 summary 引数は raw 引数も指定しないと文書全体を返すというバグがあります。なお、 $json 代替ビューを使用して返される JSON から概要を取得することもできます。
raw
Kuma に、ヘッダーやフッターなどのスキン素材のない、ページの生コンテンツを返すよう指示します。これはエディターを手軽に構築するテンプレートやスクリプトを実行しません。例: https://developer.mozilla.org/ja/docs/Web/Guide/HTML/HTML5?raw
macros
Kuma にページ内のすべてのテンプレートを実行するよう指示します。 ?raw と組み合わせると、これはサイトラッパーを除くすべてをレンダリングした MDN コンテンツを提供します。既定では ?raw なしです (つまり、通常のサイト表示です) ?raw がある時は既定でオフです。例: https://developer.mozilla.org/ja/docs/Web/Guide/HTML/HTML5?raw&macros
nomacros
Kuma にページ内の KumaScript テンプレートを実行しないよう指示します。通常のサイト表示では ?macros が既定で「オン」になっていますが、このオプションはオフにします。例: https://developer.mozilla.org/ja/docs/Web/Guide/HTML/HTML5?nomacros
include
Kuma に "noinclude" クラスを持つブロックを除くように命じます。これは単体のページではなく、他のページに含まれた場合のような出力を得るのに便利です。よくサンプルコードなどを除きます (いつもではありませんが)。例: https://developer.mozilla.org/ja/docs/XUL/Attribute/align?raw&macros&include
section=id
Kuma に指定したアンカー名を持つセクションのみのコンテンツを返すように指示します。例:
https://developer.mozilla.org/ja/docs/MDN/Contribute/Tools/Document_parameters?section=params また、もっと興味深いものは https://developer.mozilla.org/ja/docs/MDN/Contribute/Tools/Document_parameters?raw&macros&section=params
メモ: 現在、 section 引数は raw 引数も使用しないと文書全体を返すというバグがあります。
expand

$children ビューと連結して、サブページごとの詳細情報つきの JSON レスポンスを展開します。これは各サブページごとの $children$json の連結のように動作します。この方法は、サブページのタグについて学べます。例: https://developer.mozilla.org/ja/docs/Web/Guide/HTML/HTML5$children?expand

文書のメタデータリソース

文書の URL のレスポンスを微調整するための引数と一緒に、 URL 接尾辞で指定される文書の代替ビューもいくつかあります。

$toc
Kuma に HTML のページの目次のみを返すよう命じます。順序付きリスト (つまり <ol>) として返されます。例: https://developer.mozilla.org/ja/docs/MDN/Contribute/Tools/Document_parameters$toc
$json
Kuma に JSON オブジェクトでページを記述するよう命じます。このオブジェクトは基本的に、 KumaScript の処理 wiki.getPage() を使用して得られるものと同じです。例: https://developer.mozilla.org/ja/docs/Web/Guide/HTML/HTML5$json
$children
Kuma にページのトピックの子を JSON で列挙するよう命じます。このオブジェクトは基本的に、 KumaScript の処理 pages.subpages() を使用して得られるものと同じです。例: https://developer.mozilla.org/ja/docs/Web/Guide/HTML/HTML5$children これは ?expand 引数と共に使用して、もっと詳細のレスポンスを得ることもできます。
$compare
必須のクエリ引数 ?from および ?to で指定されたリビジョン間のソーステキスト行の違いを表示します。例: https://developer.mozilla.org/ja/docs/MDN/Contribute/Tools/Document_parameters$compare?to=911697&from=911067
$edit
指定された文書の現在のリビジョンを、表示する代わりに編集します。例: https://developer.mozilla.org/ja/docs/MDN/Contribute/Tools/Document_parameters$edit
$history
指定された文書の内容を表示する代わりに、最新の10リビジョンのリビジョン履歴を表示します。履歴全体は、クエリ引数の値に ?limit=all を付けることで要求できます。例: https://developer.mozilla.org/ja/docs/MDN/Contribute/Tools/Document_parameters$history?limit=all
$revision
文書の "/" の後に指定された番号のリビジョンを表示します。例: https://developer.mozilla.org/ja/docs/MDN/Contribute/Tools/Document_parameters$revision/915141