From ae1faf3f33379f8b748b968d477a6831afc0aa67 Mon Sep 17 00:00:00 2001 From: Masahiro FUJIMOTO Date: Sat, 10 Apr 2021 00:55:28 +0900 Subject: MDN/Tools/Unsupported_GET_API を更新 (#366) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - 2021/12/21 時点の英語版に基づき全面的に翻訳を改訂 --- files/ja/mdn/tools/unsupported_get_api/index.html | 99 ++++------------------- 1 file changed, 17 insertions(+), 82 deletions(-) (limited to 'files/ja') diff --git a/files/ja/mdn/tools/unsupported_get_api/index.html b/files/ja/mdn/tools/unsupported_get_api/index.html index 782d7b85a2..c6504b216a 100644 --- a/files/ja/mdn/tools/unsupported_get_api/index.html +++ b/files/ja/mdn/tools/unsupported_get_api/index.html @@ -1,96 +1,31 @@ --- -title: URL 引数と文書メタデータ +title: 非公式の GET API slug: MDN/Tools/Unsupported_GET_API tags: + - Advanced + - Automation - Documentation - - Kuma + - Draft + - Guide - MDN Meta + - PUT API - Page-level - - Reference - Tools -translation_of: MDN/Tools/Document_parameters -original_slug: MDN/Tools/Document_parameters +translation_of: MDN/Tools/Unsupported_GET_API ---
{{MDNSidebar}}
-
-

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

-
+

MDN のプラットフォームである Yari は、公式の GET API を提供していません。しかし、 Yari は現在、 HTTP の GET リクエストで受け取ることができる JSON リソースを後悔する非公式の仕組みを提供しており、プログラム的に処理することができます。

-
-

URL の GET 引数

+

index.json リソース

-

すべての Kuma wiki 文書の URL が HTTP GET で取得されたりブラウザーで見られる時に役立つクエリ引数オプションをサポートしています。

+

特定の MDN の記事の URL が与えられた場合、対応する URL に /index.json を付加したものに HTTP の GET リクエストを行うことで、関連する JSON データを取得することができます。

-

複数のクエリ引数は最初の ? の代わりに & で区切られます (マクロの例を見てください)。

+

例えば、 MDN の次の記事について、

+

https://developer.mozilla.org/ja/docs/Web/API/Fetch_API/Using_Fetch

+

...次の場所から関連する JSON データを受け取ることができます。

+

https://developer.mozilla.org/ja/docs/Web/API/Fetch_API/Using_Fetch/index.json

-
-
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 に指定したアンカー名を持つセクションのみのコンテンツを返すように指示します。
-
例: - - -
バグのお知らせ: 現在、 section 引数は raw 引数も使用しないと文書全体を返すというバグがあります。
-
-
expand
-
-

$children ビューと連結して、サブページごとの詳細情報つきの JSON レスポンスを展開します。これは各サブページごとの $children と $json の連結のように動作します。この方法は、サブページのタグについて学べます。

- -

例: https://developer.mozilla.org/ja/docs/Web/Guide/HTML/HTML5$children?expand

-
-
-
- -
-

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

- -

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

- -
-
$toc
-
Kuma に HTML のページの目次のみを返すよう命じます。順序付きリスト (つまり {{HTMLElement("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
-
-
+
+

警告: MDN の index.json リソースの JSON データに使用されるファイル形式は、バージョン管理されておらず、意図的に文書化されていません。構造やキーの名前など、書式ののあらゆる部分が変更される可能性があります。 Yari が変更されて、 index.json リソースが提供されなくなる可能性もあります。

+
-- cgit v1.2.3-54-g00ecf