API リファレンスページのテンプレート

メモ: この説明文全体を削除してから公開してください。

訳注: このテンプレートは翻訳記事用です。新たな記事を執筆する場合は、英語版を参照してください。日本語の単独記事を立項することはできません。）

ページのフロントマター:

ページ上部のフロントマターは「ページのメタデータ」を定義するために使用します。値は具体的なプロパティに応じて適切に更新してください。

---
title: NameOfTheInterface
slug: Web/API/NameOfTheInterface
l10n:
  sourceCommit: 翻訳元コミットID
---

title: タイトルの見出しは、ページの最上部に表示されます。これはインターフェイスの名前だけです。例えば、 Request インターフェイスのページには Request というタイトルを付けます。
slug: https://developer.mozilla.org/ja/docs/ の後にくる URL の末尾です。これは Web/API/インターフェイス名 のような形式になります。例えば、 Request のスラッグは "Web/API/Request" になります。
sourceCommit: （翻訳記事のみ）この記事の翻訳元となる英語版記事を GitHub にコミットした際のコミット ID を記述します。 GitHub 上で英語版記事のコミット ID を確認してください。

ページ先頭のマクロ

既定では、テンプレートの先頭に 5 つのマクロ呼び出しがあります。以下のアドバイスに従って、これらを更新または削除する必要があります。

訳注: 英語版では以下のマクロは自動的に更新されますが、翻訳記事では更新されませんので、翻訳時に手動で英語版のマクロに合わせてください。

{{SeeCompatTable}} — これは これは実験的な機能です。 のバナーを生成し、この技術が実験的であることを示します。実験的なもので、その技術が Firefox の設定で隠されている場合は、 Firefox での実験的な機能ページにもそのための項目を記入する必要があります。
{{Deprecated_Header}} — これは 非推奨 バナーを生成し、この技術が非推奨であることを示します。
{{Non-standard_Header}} — これは 標準外 バナーを生成し、この機能がどの仕様書にもないことを示します。

下記のアドバイスに従って、以下のマクロを更新または削除してください。

{{SecureContext_Header}} — これは 保護されたコンテキスト バナーを生成し、この技術が保護されたコンテキストでのみ利用できることを示します。そうではない場合は、マクロ呼び出すを削除することができます。そうである場合は、保護されたコンテキストに制限されている機能ページ内の項目も記入してください。
{{AvailableInWorkers}} — これにより、ウェブワーカーで利用可能というメモが生成され、その技術がウェブワーカーのコンテキストで利用可能であることを示します。ウィンドウコンテキストでのみ利用できる場合は、そのマクロの呼び出しを除去できます。もしそれがワーカーコンテキストでも利用できる、あるいはワーカーコンテキストでのみ利用できる場合、その利用状況に応じて引数を渡す必要があることがあります（利用できるすべての値については、{{AvailableInWorkers}} マクロのソースコードをご参照ください）。また、ウェブワーカーで利用可能な Web API ページに、その項目を追加する必要があることがあります。
{{APIRef("GroupDataName")}} — これにより、現在のページに関連するクイックリファレンスリンクを表示する左側のサイドバーが生成されます。例えば、WebVR API のすべてのページには同じサイドバーがあり、API 内の他のページへのリンクが掲載されています。この API 用に正しいサイドバーを生成するには、 GroupData 項目を追加し、マクロ呼び出し内の GroupDataName の代わりにその項目名を記載する必要があります。この方法についての情報は、API リファレンスサイドバーのガイドをご覧ください。

訳注: 英語版では状態ヘッダーマクロは自動的に更新されますが、翻訳記事では更新されません。翻訳時に英語版に合わせて手動で更新してください。

保護されたコンテキスト、ワーカーで利用可能、実験的、非推奨、標準外 の各バナーは、このメモブロックの直後に表示しています。

公開前に、忘れずにこの説明文全体を削除してください。

安全なコンテキスト用: この機能は一部またはすべての対応しているブラウザーにおいて、安全なコンテキスト (HTTPS) でのみ利用できます。

メモ: この機能はウェブワーカー内で利用可能です。

Experimental: これは実験的な機能です。
本番で使用する前にブラウザー互換性一覧表をチェックしてください。

非推奨;: この機能は非推奨になりました。まだ対応しているブラウザーがあるかもしれませんが、すでに関連するウェブ標準から削除されているか、削除の手続き中であるか、互換性のためだけに残されている可能性があります。使用を避け、できれば既存のコードは更新してください。このページの下部にある互換性一覧表を見て判断してください。この機能は突然動作しなくなる可能性があることに注意してください。

非標準: この機能は標準化されていません。非標準の機能はブラウザーの対応が限られ、将来的に変更または削除される可能性があるため、本番環境での使用は推奨されません。ただし、標準の選択肢が存在しない特定のケースでは、有効な代替手段となる場合があります。

概要の段落 - まず、インターフェイスの名前、それがどのインターフェイスに属しているか、そしてそれが何をするものなのかを述べます。これはできれば 1、2 の短い文にすべきです。対応する API ランディングページのインターフェイスの概要から、この大部分をコピーすることができます。

{{InheritanceDiagram}}

下記の節で domxref マクロを使用するには、マークダウンファイルの逆引用符とバックスラッシュを除去してください。

コンストラクター

{{DOMxRef("NameOfTheInterface.NameOfTheInterface", "NameOfTheInterface()")}}: NameOfTheInterface オブジェクトのインスタンスを生成します。

静的プロパティ

親インターフェイスである {{DOMxRef("NameOfParentInterface")}} から継承したプロパティもあります。 （注: このインターフェイスが他のインターフェイスを継承していない場合は、この行全体を削除してください。）

プロパティごとに 1 つずつ用語と定義を記述してください。

{{DOMxRef("NameOfTheInterface.staticProperty1")}} 読取専用: このプロパティの簡単な説明と、それが何をするものかを記載してください。プロパティが読み取り専用/実験的/非推奨でない場合、関連するマクロの呼び出しを削除してください。
{{DOMxRef("NameOfTheInterface.staticProperty2")}}: このプロパティの簡単な説明と、それが何をするものかを記載してください。プロパティが読み取り専用/実験的/非推奨でない場合、関連するマクロの呼び出しを削除してください。

インスタンスプロパティ

プロパティごとに 1 つずつ用語と定義を記述してください。

{{DOMxRef("NameOfTheInterface.property1")}} 読取専用: このプロパティの簡単な説明と、それが何をするものかを記載してください。プロパティが読み取り専用/実験的/非推奨でない場合、関連するマクロの呼び出しを削除してください。
{{DOMxRef("NameOfTheInterface.property2")}}: このプロパティの簡単な説明と、それが何をするものかを記載してください。プロパティが読み取り専用/実験的/非推奨/標準外でない場合、関連するマクロの呼び出しを削除してください。

静的メソッド

親インターフェイスである {{DOMxRef("NameOfParentInterface")}} から継承したメソッドもあります。 （注: このインターフェイスが他のインターフェイスを継承していない場合は、この行全体を削除してください。）

メソッドごとに 1 つずつ用語と定義を記述してください。

{{DOMxRef("NameOfTheInterface.staticMethod1()")}}: ここにメソッドの簡単な説明と何をするものかを記載してください。メソッドが実験的/非推奨/標準外でない場合、関連するマクロの呼び出しを削除してください。
{{DOMxRef("NameOfTheInterface.staticMethod2()")}}: ここにメソッドの簡単な説明と何をするものかを記載してください。メソッドが実験的/非推奨/標準外でない場合、関連するマクロの呼び出しを削除してください。

インスタンスメソッド

メソッドごとに 1 つずつ用語と定義を記述してください。

{{DOMxRef("NameOfTheInterface.method1()")}}: ここにメソッドの簡単な説明と何をするものかを記載してください。メソッドが実験的/非推奨/標準外でない場合、関連するマクロの呼び出しを削除してください。
{{DOMxRef("NameOfTheInterface.method2()")}}: ここにメソッドの簡単な説明と何をするものかを記載してください。メソッドが実験的/非推奨/標準外でない場合、関連するマクロの呼び出しを削除してください。

イベント

親インターフェイスである {{DOMxRef("NameOfParentInterface")}} から継承したイベントもあります。 （注: このインターフェイスが他のインターフェイスを継承していない場合は、この行全体を削除してください。）

これらのイベントを待ち受けするには、 addEventListener() を使用するか、このインターフェイスの oneventname プロパティにイベントリスナーを代入するかしてください。

{{DOMxRef("NameOfTheInterface.event1", "event1")}}: ～時に発生します（イベントがいつ発行されるかの説明を記載する）。 oneventname1 プロパティでも利用できます。そのイベントが実験的/非推奨/標準外のものでない場合は、関連するマクロ呼び出しを除去してください。
{{DOMxRef("NameOfTheInterface.event2", "event2")}}: ～時に発生します (イベントがいつ発行されるかの説明を記載する). oneventname2 プロパティでも利用できます。そのイベントが実験的/非推奨/標準外のものでない場合は、関連するマクロ呼び出しを除去してください。

例

英語版では、ページ内に例が 1 つしかない場合でも、複数形の "Examples" を使用しています。

説明的な見出し

それぞれの例には、その例を説明する H3 見出し (###) がなければなりません。見出しは例が何を行っているかを説明するものであるべきです。例えば、「単純な例」というのは例について何も説明していないので、良い見出しとは言えません。見出しは簡潔であるべきです。より詳しい説明をする場合は、見出しの後の段落を使用してください。

詳しくは、サンプルコードを追加する方法のガイドをご覧ください。

メモ: 他のページで紹介されている例にリンクしたい場合もあるでしょう。

シナリオ 1: このページにいくつかの例があり、別のページにさらにいくつかの例がある場合。

このページのそれぞれの例に H3 見出し (###) を記載し、最後に H3 見出し (###) に「その他の例」というテキストを入れ、その下に他のページの例へのリンクを貼ることができます。例えば次のようにします。

## 例

### Fetch API の使用

Fetch の例

### その他の例

他のページにある他の例へのリンク

シナリオ 2: このページには何も例がなく、他のページにだけある場合。

H3 の見出しは追加せず、 H2 の見出し「例」の下に直接リンクを追加してください。例えば次のようにします。

## 例

この API の例については、 [fetch() のページ](https://example.org/)を参照してください。

仕様書

{{Specifications}}

このマクロを使用するには、マークダウンファイルの逆引用符とバックスラッシュを除去してください。

ブラウザーの互換性

{{Compat}}

このマクロを使用するには、マークダウンファイルの逆引用符とバックスラッシュを除去してください。

MDN の改良に協力

協力方法を知る

このページは MDN の貢献者によって 2026年5月8日に最終更新されました。

GitHub でこのページを表示 • このコンテンツに関する問題を報告