エンジニアなりたての頃、MDNのWeb APIドキュメントを読むのが苦手でした。
似たようなタイトルのページが多かったりパニック状態です。そしてそっと閉じてました。
そこで、MDNのWebドキュメントがすんなり理解できるようにどのようなページ構成になっていて、どのページをもればどのような情報が取得できるのか、体系的にまとめてみたいと思います。
想定読者
- Webアプリケーションエンジニア
- MDNのWeb APIドキュメントどこに何があんだ?って人
スコープ
- MDNドキュメントのページ構成と各ページから得られる情報
扱わない内容
- 各APIに関する詳細の説明
MDN Web APIドキュメント早見表
| ページ | 階層 | 概要 |
|---|---|---|
| Topページ | docs/Web/API | Web APIの一覧ページで各APIの詳細ページに飛べます |
| 仕様解説ページ | docs/Web/API/[API名] | 対象のWeb APIの仕様概要ページです。〇〇APIというタイトルになってるページが多い。APIを使用する際にまずは一読して全体像を掴むために必読のページです。 |
| Interfaceページ | docs/Web/API/[インターフェース名] | 対象のWeb APIで利用できるプロパティやメソッドの情報が確認できます |
| インスタンスメソッドページ | docs/Web/API/[インターフェース名]/[メソッド名] | APIで利用可能なメソッド名の使用方法が記載されています。引数や戻り値の型などが参照できます。使用例も記載されていることが多いので、実装時はこのページにお世話になることが多い |