API リファレンス

クライアント側の JavaScript API は、ウェブ上で利用可能な技術の大部分を占めています。MDN には、これらの API で使用できる機能とその使用方法を説明する広範囲な参考資料が含まれています。このガイドセットでは MDN で API リファレンス資料を作成する方法について説明します。

事前に準備するリソース

API の文書化を開始する前に、次のものが必要です。

  1. 最新の仕様: W3C 勧告か初期の編集者の草稿かどうかに関わらず、その API をカバーする仕様の最新の草稿 (またはその仕様を参照) を参照する必要があります。通常それはウェブ検索で見つかります。最新のバージョンは「最新草稿」、またはそれに類するものの下にリストされている仕様のすべてのバージョンからリンクされることがよくあります。
  2. 最新のウェブブラウザー: Firefox Nightly/Chrome Canary のような実験的/アルファ版のものが、あなたが文書化している機能をサポートする可能性が高いはずです。これは初期の/実験的な API を文書化している場合に特に関係します。
  3. デモ/ブログ記事/その他の情報: できるだけ多くの情報を探しましょう。主なインターフェイス/プロパティ/メソッドが何であるか、主要な用途は何であるか、そしてそれを使って簡単な機能を書く方法を学ぶことで、API の仕組みに慣れるための時間を費やすことから始めておくと便利です。
  4. 有益なエンジニアリングの連絡先: 仕様、API の標準化に携わっている人、またはブラウザでの実装について質問するためのフレンドリーなエンジニアリング担当者を見つけることは本当に便利です。見つけるのに適した場所は次のとおりです。
    • 関連会社に勤めている場合は、社内のアドレス帳。
    • Mozilla の dev-platformdev-webapi のリスト、public-webapps のような W3C のリストなど、その API の議論に関係する公開メーリングリスト。
    • 仕様そのもの。たとえば、 Web Audio API の仕様書では著者とその連絡先の詳細が上部に表示されています。

高水準の構造

What does an API reference need?
この記事では完全な API リファレンスに必要なページについて説明します。
Page types
MDN に繰り返し使用されるいくつかの種類のページがあります。この記事では、これらのページ種別とその目的、および新しいページを作成するときに使用する各テンプレートとテンプレートの例について説明します。

個々のページの特徴

これらの記事では、API リファレンスページに必要な個々のページの特徴を作成する方法について説明します。

API リファレンスサイドバー
MDN API リファレンス記事にサイドバーを含めると、その API に関連する関連インタフェース、チュートリアル、その他のリソースへのリンクが表示されるようにカスタマイズできます。この記事では、この方法について説明します。
構文の節
MDN リファレンスページの構文の節には、その機能が持つ正確な構文 (例えば、どのような引数を受け付けるか、どの引数がオプションかなど) を定義する構文ボックスが含まれています。
コード例
MDN には、ウェブプラットフォーム機能の使用方法を示すために、ページ全体に挿入された多数のコード例があります。この記事ではコードの例をページに追加する際に使用できるさまざまなメカニズムと、使用する必要があるものとそのタイミングについて説明します。
仕様書一覧表
MDN のすべてのリファレンスページは、その API または技術が定義されている仕様または仕様に関する情報を提供する必要があります。この資料では、これらのテーブルの外観とその構成方法について説明します。
互換性一覧表
MDN には、公開されているウェブ文書の互換性一覧表の標準フォーマットがあります。つまり、すべてのブラウザーで共有されているDOM、HTML、CSS、JavaScript、SVG などの技術の文書です。この記事では、機能を使用して MDN ページに互換性データを追加する方法について説明します。