CINXE.COM

<!doctype html><html lang="en-US" prefix="og: https://ogp.me/ns#"><head><meta charSet="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1"/><link rel="icon" href="https://developer.mozilla.org/favicon-48x48.bc390275e955dacb2e65.png"/><link rel="apple-touch-icon" href="https://developer.mozilla.org/apple-touch-icon.528534bba673c38049c2.png"/><meta name="theme-color" content="#ffffff"/><link rel="manifest" href="https://developer.mozilla.org/manifest.f42880861b394dd4dc9b.json"/><link rel="search" type="application/opensearchdescription+xml" href="/opensearch.xml" title="MDN Web Docs"/><title>API リファレンスの書き方 - MDN Web Docs プロジェクト | MDN</title><link rel="alternate" title="How to write an API reference" href="https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Howto/Write_an_api_reference" hrefLang="en"/><link rel="alternate" title="Anleitung zum Schreiben einer API-Referenz" href="https://developer.mozilla.org/de/docs/MDN/Writing_guidelines/Howto/Write_an_api_reference" hrefLang="de"/><link rel="alternate" title="如何撰写 API 参考文档" href="https://developer.mozilla.org/zh-CN/docs/MDN/Writing_guidelines/Howto/Write_an_api_reference" hrefLang="zh"/><link rel="alternate" title="API リファレンスの書き方" href="https://developer.mozilla.org/ja/docs/MDN/Writing_guidelines/Howto/Write_an_api_reference" hrefLang="ja"/><link rel="preload" as="font" type="font/woff2" href="/static/media/Inter.var.c2fe3cb2b7c746f7966a.woff2" crossorigin=""/><link rel="alternate" type="application/rss+xml" title="MDN Blog RSS Feed" href="https://developer.mozilla.org/en-US/blog/rss.xml" hrefLang="en"/><meta name="description" content="このガイドでは、 MDN で API リファレンスを書くために必要なすべてのことを説明します。"/><meta property="og:url" content="https://developer.mozilla.org/ja/docs/MDN/Writing_guidelines/Howto/Write_an_api_reference"/><meta property="og:title" content="API リファレンスの書き方 - MDN Web Docs プロジェクト | MDN"/><meta property="og:type" content="website"/><meta property="og:locale" content="ja"/><meta property="og:description" content="このガイドでは、 MDN で API リファレンスを書くために必要なすべてのことを説明します。"/><meta property="og:image" content="https://developer.mozilla.org/mdn-social-share.d893525a4fb5fb1f67a2.png"/><meta property="og:image:type" content="image/png"/><meta property="og:image:height" content="1080"/><meta property="og:image:width" content="1920"/><meta property="og:image:alt" content="The MDN Web Docs logo, featuring a blue accent color, displayed on a solid black background."/><meta property="og:site_name" content="MDN Web Docs"/><meta name="twitter:card" content="summary_large_image"/><meta name="twitter:creator" content="MozDevNet"/><link rel="canonical" href="https://developer.mozilla.org/ja/docs/MDN/Writing_guidelines/Howto/Write_an_api_reference"/><style media="print">.article-actions-container,.document-toc-container,.language-menu,.main-menu-toggle,.on-github,.page-footer,.place,.sidebar,.top-banner,.top-navigation-main,ul.prev-next{display:none!important}.main-page-content,.main-page-content pre{padding:2px}.main-page-content pre{border-left-width:2px}</style><script src="/static/js/gtag.js" defer=""></script><script defer="" src="/static/js/main.f565372a.js"></script><link href="/static/css/main.3d9e7a02.css" rel="stylesheet"/></head><body><script>if(document.body.addEventListener("load",(t=>{t.target.classList.contains("interactive")&&t.target.setAttribute("data-readystate","complete")}),{capture:!0}),window&&document.documentElement){const t={light:"#ffffff",dark:"#1b1b1b"};try{const e=window.localStorage.getItem("theme");e&&(document.documentElement.className=e,document.documentElement.style.backgroundColor=t[e]);const o=window.localStorage.getItem("nop");o&&(document.documentElement.dataset.nop=o)}catch(t){console.warn("Unable to read theme from localStorage",t)}}</script><div id="root"><ul id="nav-access" class="a11y-nav"><li><a id="skip-main" href="#content">Skip to main content</a></li><li><a id="skip-search" href="#top-nav-search-input">Skip to search</a></li><li><a id="skip-select-language" href="#languages-switcher-button">Skip to select language</a></li></ul><div class="page-wrapper document-page"><div class="top-banner loading"><section class="place top container"></section></div><div class="sticky-header-container"><header class="top-navigation "><div class="container "><div class="top-navigation-wrap"><a href="/ja/" class="logo" aria-label="MDN homepage"><svg id="mdn-docs-logo" xmlns="http://www.w3.org/2000/svg" x="0" y="0" viewBox="0 0 694.9 104.4" style="enable-background:new 0 0 694.9 104.4" xml:space="preserve" role="img"><title>MDN Web Docs</title><path d="M40.3 0 11.7 92.1H0L28.5 0h11.8zm10.4 0v92.1H40.3V0h10.4zM91 0 62.5 92.1H50.8L79.3 0H91zm10.4 0v92.1H91V0h10.4z" class="logo-m"></path><path d="M627.9 95.6h67v8.8h-67v-8.8z" class="logo-_"></path><path d="M367 42h-4l-10.7 30.8h-5.5l-10.8-26h-.4l-10.5 26h-5.2L308.7 42h-3.8v-5.6H323V42h-6.5l6.8 20.4h.4l10.3-26h4.7l11.2 26h.5l5.7-20.3h-6.2v-5.6H367V42zm34.9 20c-.4 3.2-2 5.9-4.7 8.2-2.8 2.3-6.5 3.4-11.3 3.4-5.4 0-9.7-1.6-13.1-4.7-3.3-3.2-5-7.7-5-13.7 0-5.7 1.6-10.3 4.7-14s7.4-5.5 12.9-5.5c5.1 0 9.1 1.6 11.9 4.7s4.3 6.9 4.3 11.3c0 1.5-.2 3-.5 4.7h-25.6c.3 7.7 4 11.6 10.9 11.6 2.9 0 5.1-.7 6.5-2 1.5-1.4 2.5-3 3-4.9l6 .9zM394 51.3c.2-2.4-.4-4.7-1.8-6.9s-3.8-3.3-7-3.3c-3.1 0-5.3 1-6.9 3-1.5 2-2.5 4.4-2.8 7.2H394zm51 2.4c0 5-1.3 9.5-4 13.7s-6.9 6.2-12.7 6.2c-6 0-10.3-2.2-12.7-6.7-.1.4-.2 1.4-.4 2.9s-.3 2.5-.4 2.9h-7.3c.3-1.7.6-3.5.8-5.3.3-1.8.4-3.7.4-5.5V22.3h-6v-5.6H416v27c1.1-2.2 2.7-4.1 4.7-5.7 2-1.6 4.8-2.4 8.4-2.4 4.6 0 8.4 1.6 11.4 4.7 3 3.2 4.5 7.6 4.5 13.4zm-7.7.6c0-4.2-1-7.4-3-9.5-2-2.2-4.4-3.3-7.4-3.3-3.4 0-6 1.2-8 3.7-1.9 2.4-2.9 5-3 7.7V57c0 3 1 5.6 3 7.7s4.5 3.1 7.6 3.1c3.6 0 6.3-1.3 8.1-3.9 1.8-2.7 2.7-5.9 2.7-9.6zm69.2 18.5h-13.2v-7.2c-1.2 2.2-2.8 4.1-4.9 5.6-2.1 1.6-4.8 2.4-8.3 2.4-4.8 0-8.7-1.6-11.6-4.9-2.9-3.2-4.3-7.7-4.3-13.3 0-5 1.3-9.6 4-13.7 2.6-4.1 6.9-6.2 12.8-6.2 5.7 0 9.8 2.2 12.3 6.5V22.3h-8.6v-5.6h15.8v50.6h6v5.5zM493.2 56v-4.4c-.1-3-1.2-5.5-3.2-7.3s-4.4-2.8-7.2-2.8c-3.6 0-6.3 1.3-8.2 3.9-1.9 2.6-2.8 5.8-2.8 9.6 0 4.1 1 7.3 3 9.5s4.5 3.3 7.4 3.3c3.2 0 5.8-1.3 7.8-3.8 2.1-2.6 3.1-5.3 3.2-8zm53.1-1.4c0 5.6-1.8 10.2-5.3 13.7s-8.2 5.3-13.9 5.3-10.1-1.7-13.4-5.1c-3.3-3.4-5-7.9-5-13.5 0-5.3 1.6-9.9 4.7-13.7 3.2-3.8 7.9-5.7 14.2-5.7s11 1.9 14.1 5.7c3 3.7 4.6 8.1 4.6 13.3zm-7.7-.2c0-4-1-7.2-3-9.5s-4.8-3.5-8.2-3.5c-3.6 0-6.4 1.2-8.3 3.7s-2.9 5.6-2.9 9.5c0 3.7.9 6.8 2.8 9.4 1.9 2.6 4.6 3.9 8.3 3.9 3.6 0 6.4-1.3 8.4-3.8 1.9-2.6 2.9-5.8 2.9-9.7zm45 5.8c-.4 3.2-1.9 6.3-4.4 9.1-2.5 2.9-6.4 4.3-11.8 4.3-5.2 0-9.4-1.6-12.6-4.8-3.2-3.2-4.8-7.7-4.8-13.7 0-5.5 1.6-10.1 4.7-13.9 3.2-3.8 7.6-5.7 13.2-5.7 2.3 0 4.6.3 6.7.8 2.2.5 4.2 1.5 6.2 2.9l1.5 9.5-5.9.7-1.3-6.1c-2.1-1.2-4.5-1.8-7.2-1.8-3.5 0-6.1 1.2-7.7 3.7-1.7 2.5-2.5 5.7-2.5 9.6 0 4.1.9 7.3 2.7 9.5 1.8 2.3 4.4 3.4 7.8 3.4 5.2 0 8.2-2.9 9.2-8.8l6.2 1.3zm34.7 1.9c0 3.6-1.5 6.5-4.6 8.5s-7 3-11.7 3c-5.7 0-10.6-1.2-14.6-3.6l1.2-8.8 5.7.6-.2 4.7c1.1.5 2.3.9 3.6 1.1s2.6.3 3.9.3c2.4 0 4.5-.4 6.5-1.3 1.9-.9 2.9-2.2 2.9-4.1 0-1.8-.8-3.1-2.3-3.8s-3.5-1.3-5.8-1.7-4.6-.9-6.9-1.4c-2.3-.6-4.2-1.6-5.7-2.9-1.6-1.4-2.3-3.5-2.3-6.3 0-4.1 1.5-6.9 4.6-8.5s6.4-2.4 9.9-2.4c2.6 0 5 .3 7.2.9 2.2.6 4.3 1.4 6.1 2.4l.8 8.8-5.8.7-.8-5.7c-2.3-1-4.7-1.6-7.2-1.6-2.1 0-3.7.4-5.1 1.1-1.3.8-2 2-2 3.8 0 1.7.8 2.9 2.3 3.6 1.5.7 3.4 1.2 5.7 1.6 2.2.4 4.5.8 6.7 1.4 2.2.6 4.1 1.6 5.7 3 1.4 1.6 2.2 3.7 2.2 6.6zM197.6 73.2h-17.1v-5.5h3.8V51.9c0-3.7-.7-6.3-2.1-7.9-1.4-1.6-3.3-2.3-5.7-2.3-3.2 0-5.6 1.1-7.2 3.4s-2.4 4.6-2.5 6.9v15.6h6v5.5h-17.1v-5.5h3.8V51.9c0-3.8-.7-6.4-2.1-7.9-1.4-1.5-3.3-2.3-5.6-2.3-3.2 0-5.5 1.1-7.2 3.3-1.6 2.2-2.4 4.5-2.5 6.9v15.8h6.9v5.5h-20.2v-5.5h6V42.4h-6.1v-5.6h13.4v6.4c1.2-2.1 2.7-3.8 4.7-5.2 2-1.3 4.4-2 7.3-2s5.3.7 7.5 2.1c2.2 1.4 3.7 3.5 4.5 6.4 1.1-2.5 2.7-4.5 4.9-6.1s4.8-2.4 7.9-2.4c3.5 0 6.5 1.1 8.9 3.3s3.7 5.6 3.7 10.2v18.2h6.1v5.5zm42.5 0h-13.2V66c-1.2 2.2-2.8 4.1-4.9 5.6-2.1 1.6-4.8 2.4-8.3 2.4-4.8 0-8.7-1.6-11.6-4.9-2.9-3.2-4.3-7.7-4.3-13.3 0-5 1.3-9.6 4-13.7 2.6-4.1 6.9-6.2 12.8-6.2s9.8 2.2 12.3 6.5V22.7h-8.6v-5.6h15.8v50.6h6v5.5zm-13.3-16.8V52c-.1-3-1.2-5.5-3.2-7.3s-4.4-2.8-7.2-2.8c-3.6 0-6.3 1.3-8.2 3.9-1.9 2.6-2.8 5.8-2.8 9.6 0 4.1 1 7.3 3 9.5s4.5 3.3 7.4 3.3c3.2 0 5.8-1.3 7.8-3.8 2.1-2.6 3.1-5.3 3.2-8zm61.5 16.8H269v-5.5h6V51.9c0-3.7-.7-6.3-2.2-7.9-1.4-1.6-3.4-2.3-5.7-2.3-3.1 0-5.6 1-7.4 3s-2.8 4.4-2.9 7v15.9h6v5.5h-19.3v-5.5h6V42.4h-6.2v-5.6h13.6V43c2.6-4.6 6.8-6.9 12.7-6.9 3.6 0 6.7 1.1 9.2 3.3s3.7 5.6 3.7 10.2v18.2h6v5.4h-.2z" class="logo-text"></path></svg></a><button title="Open main menu" type="button" class="button action has-icon main-menu-toggle" aria-haspopup="menu" aria-label="Open main menu" aria-expanded="false"><span class="button-wrap"><span class="icon icon-menu "></span><span class="visually-hidden">Open main menu</span></span></button></div><div class="top-navigation-main"><nav class="main-nav" aria-label="Main menu"><ul class="main-menu nojs"><li class="top-level-entry-container "><button type="button" id="references-button" class="top-level-entry menu-toggle" aria-controls="references-menu" aria-expanded="false">References</button><a href="/ja/docs/Web" class="top-level-entry">References</a><ul id="references-menu" class="submenu references hidden inline-submenu-lg" aria-labelledby="references-button"><li class="apis-link-container mobile-only "><a href="/ja/docs/Web" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">Overview / Web Technology</div><p class="submenu-item-description">Web technology reference for developers</p></div></a></li><li class="html-link-container "><a href="/ja/docs/Web/HTML" class="submenu-item "><div class="submenu-icon html"></div><div class="submenu-content-container"><div class="submenu-item-heading">HTML</div><p class="submenu-item-description">Structure of content on the web</p></div></a></li><li class="css-link-container "><a href="/ja/docs/Web/CSS" class="submenu-item "><div class="submenu-icon css"></div><div class="submenu-content-container"><div class="submenu-item-heading">CSS</div><p class="submenu-item-description">Code used to describe document style</p></div></a></li><li class="javascript-link-container "><a href="/ja/docs/Web/JavaScript" class="submenu-item "><div class="submenu-icon javascript"></div><div class="submenu-content-container"><div class="submenu-item-heading">JavaScript</div><p class="submenu-item-description">General-purpose scripting language</p></div></a></li><li class="http-link-container "><a href="/ja/docs/Web/HTTP" class="submenu-item "><div class="submenu-icon http"></div><div class="submenu-content-container"><div class="submenu-item-heading">HTTP</div><p class="submenu-item-description">Protocol for transmitting web resources</p></div></a></li><li class="apis-link-container "><a href="/ja/docs/Web/API" class="submenu-item "><div class="submenu-icon apis"></div><div class="submenu-content-container"><div class="submenu-item-heading">Web APIs</div><p class="submenu-item-description">Interfaces for building web applications</p></div></a></li><li class="apis-link-container "><a href="/ja/docs/Mozilla/Add-ons/WebExtensions" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">Web Extensions</div><p class="submenu-item-description">Developing extensions for web browsers</p></div></a></li><li class=" "><a href="/ja/docs/Web/Accessibility" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">Accessibility</div><p class="submenu-item-description">Build web projects usable for all</p></div></a></li><li class="apis-link-container desktop-only "><a href="/ja/docs/Web" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">Web Technology</div><p class="submenu-item-description">Web technology reference for developers</p></div></a></li></ul></li><li class="top-level-entry-container "><button type="button" id="learn-button" class="top-level-entry menu-toggle" aria-controls="learn-menu" aria-expanded="false">Learn</button><a href="/ja/docs/Learn_web_development" class="top-level-entry">Learn</a><ul id="learn-menu" class="submenu learn hidden inline-submenu-lg" aria-labelledby="learn-button"><li class="apis-link-container mobile-only "><a href="/ja/docs/Learn_web_development" class="submenu-item "><div class="submenu-icon learn"></div><div class="submenu-content-container"><div class="submenu-item-heading">Overview / MDN Learning Area</div><p class="submenu-item-description">Learn web development</p></div></a></li><li class="apis-link-container desktop-only "><a href="/ja/docs/Learn_web_development" class="submenu-item "><div class="submenu-icon learn"></div><div class="submenu-content-container"><div class="submenu-item-heading">MDN Learning Area</div><p class="submenu-item-description">Learn web development</p></div></a></li><li class="html-link-container "><a href="/ja/docs/Learn_web_development/Core/Structuring_content" class="submenu-item "><div class="submenu-icon html"></div><div class="submenu-content-container"><div class="submenu-item-heading">HTML</div><p class="submenu-item-description">Learn to structure web content with HTML</p></div></a></li><li class="css-link-container "><a href="/ja/docs/Learn_web_development/Core/Styling_basics" class="submenu-item "><div class="submenu-icon css"></div><div class="submenu-content-container"><div class="submenu-item-heading">CSS</div><p class="submenu-item-description">Learn to style content using CSS</p></div></a></li><li class="javascript-link-container "><a href="/ja/docs/Learn_web_development/Core/Scripting" class="submenu-item "><div class="submenu-icon javascript"></div><div class="submenu-content-container"><div class="submenu-item-heading">JavaScript</div><p class="submenu-item-description">Learn to run scripts in the browser</p></div></a></li><li class=" "><a href="/ja/docs/Learn_web_development/Core/Accessibility" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">Accessibility</div><p class="submenu-item-description">Learn to make the web accessible to all</p></div></a></li></ul></li><li class="top-level-entry-container "><button type="button" id="mdn-plus-button" class="top-level-entry menu-toggle" aria-controls="mdn-plus-menu" aria-expanded="false">Plus</button><a href="/ja/plus" class="top-level-entry">Plus</a><ul id="mdn-plus-menu" class="submenu mdn-plus hidden inline-submenu-lg" aria-labelledby="mdn-plus-button"><li class=" "><a href="/ja/plus" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">Overview</div><p class="submenu-item-description">A customized MDN experience</p></div></a></li><li class=" "><a href="/ja/plus/ai-help" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">AI Help</div><p class="submenu-item-description">Get real-time assistance and support</p></div></a></li><li class=" "><a href="/ja/plus/updates" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">Updates</div><p class="submenu-item-description">All browser compatibility updates at a glance</p></div></a></li><li class=" "><a href="/en-US/plus/docs/features/overview" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">Documentation</div><p class="submenu-item-description">Learn how to use MDN Plus</p></div></a></li><li class=" "><a href="/en-US/plus/docs/faq" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">FAQ</div><p class="submenu-item-description">Frequently asked questions about MDN Plus</p></div></a></li></ul></li><li class="top-level-entry-container "><a class="top-level-entry menu-link" href="/en-US/curriculum/">Curriculum <sup class="new">New</sup></a></li><li class="top-level-entry-container "><a class="top-level-entry menu-link" href="/en-US/blog/">Blog</a></li><li class="top-level-entry-container "><button type="button" id="tools-button" class="top-level-entry menu-toggle" aria-controls="tools-menu" aria-expanded="false">Tools</button><ul id="tools-menu" class="submenu tools hidden inline-submenu-lg" aria-labelledby="tools-button"><li class=" "><a href="/ja/play" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">Playground</div><p class="submenu-item-description">Write, test and share your code</p></div></a></li><li class=" "><a href="/en-US/observatory" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">HTTP Observatory</div><p class="submenu-item-description">Scan a website for free</p></div></a></li><li class=" "><a href="/en-US/plus/ai-help" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">AI Help</div><p class="submenu-item-description">Get real-time assistance and support</p></div></a></li></ul></li></ul></nav><div class="header-search"><form action="/ja/search" class="search-form search-widget" id="top-nav-search-form" role="search"><label id="top-nav-search-label" for="top-nav-search-input" class="visually-hidden">Search MDN</label><input aria-activedescendant="" aria-autocomplete="list" aria-controls="top-nav-search-menu" aria-expanded="false" aria-labelledby="top-nav-search-label" autoComplete="off" id="top-nav-search-input" role="combobox" type="search" class="search-input-field" name="q" placeholder=" " required="" value=""/><button type="button" class="button action has-icon clear-search-button"><span class="button-wrap"><span class="icon icon-cancel "></span><span class="visually-hidden">Clear search input</span></span></button><button type="submit" class="button action has-icon search-button"><span class="button-wrap"><span class="icon icon-search "></span><span class="visually-hidden">Search</span></span></button><div id="top-nav-search-menu" role="listbox" aria-labelledby="top-nav-search-label"></div></form></div><div class="theme-switcher-menu"><button type="button" class="button action has-icon theme-switcher-menu small" aria-haspopup="menu"><span class="button-wrap"><span class="icon icon-theme-os-default "></span>Theme</span></button></div><ul class="auth-container"><li><a href="/users/fxa/login/authenticate/?next=%2Fja%2Fdocs%2FMDN%2FWriting_guidelines%2FHowto%2FWrite_an_api_reference" class="login-link" rel="nofollow">Log in</a></li><li><a href="/users/fxa/login/authenticate/?next=%2Fja%2Fdocs%2FMDN%2FWriting_guidelines%2FHowto%2FWrite_an_api_reference" target="_self" rel="nofollow" class="button primary mdn-plus-subscribe-link"><span class="button-wrap">Sign up for free</span></a></li></ul></div></div></header><div class="article-actions-container"><div class="container"><button type="button" class="button action has-icon sidebar-button" aria-label="Expand sidebar" aria-expanded="false" aria-controls="sidebar-quicklinks"><span class="button-wrap"><span class="icon icon-sidebar "></span></span></button><nav class="breadcrumbs-container" aria-label="Breadcrumb"><ol typeof="BreadcrumbList" vocab="https://schema.org/" aria-label="breadcrumbs"><li property="itemListElement" typeof="ListItem"><a href="/ja/docs/MDN" class="breadcrumb" property="item" typeof="WebPage"><span property="name">MDN Web Docs プロジェクト</span></a><meta property="position" content="1"/></li><li property="itemListElement" typeof="ListItem"><a href="/ja/docs/MDN/Writing_guidelines" class="breadcrumb" property="item" typeof="WebPage"><span property="name">執筆ガイドライン</span></a><meta property="position" content="2"/></li><li property="itemListElement" typeof="ListItem"><a href="/ja/docs/MDN/Writing_guidelines/Howto" class="breadcrumb" property="item" typeof="WebPage"><span property="name">How-to ガイド</span></a><meta property="position" content="3"/></li><li property="itemListElement" typeof="ListItem"><a href="/ja/docs/MDN/Writing_guidelines/Howto/Write_an_api_reference" class="breadcrumb-current-page" property="item" typeof="WebPage"><span property="name">API リファレンスの書き方</span></a><meta property="position" content="4"/></li></ol></nav><div class="article-actions"><button type="button" class="button action has-icon article-actions-toggle" aria-label="Article actions"><span class="button-wrap"><span class="icon icon-ellipses "></span><span class="article-actions-dialog-heading">Article Actions</span></span></button><ul class="article-actions-entries"><li class="article-actions-entry"><div class="languages-switcher-menu open-on-focus-within"><button id="languages-switcher-button" type="button" class="button action small has-icon languages-switcher-menu" aria-haspopup="menu"><span class="button-wrap"><span class="icon icon-language "></span>日本語</span></button><div class="hidden"><ul class="submenu language-menu " aria-labelledby="language-menu-button"><li class=" "><form class="submenu-item locale-redirect-setting"><div class="group"><label class="switch"><input type="checkbox" name="locale-redirect"/><span class="slider"></span><span class="label">Remember language</span></label><a href="https://github.com/orgs/mdn/discussions/739" rel="external noopener noreferrer" target="_blank" title="Enable this setting to automatically switch to this language when it's available. (Click to learn more.)"><span class="icon icon-question-mark "></span></a></div></form></li><li class=" "><a data-locale="en-US" href="/en-US/docs/MDN/Writing_guidelines/Howto/Write_an_api_reference" class="button submenu-item"><span>English (US)</span></a></li><li class=" "><a data-locale="de" href="/de/docs/MDN/Writing_guidelines/Howto/Write_an_api_reference" class="button submenu-item"><span>Deutsch</span><span title="Diese Übersetzung ist Teil eines Experiments."><span class="icon icon-experimental "></span></span></a></li><li class=" "><a data-locale="zh-CN" href="/zh-CN/docs/MDN/Writing_guidelines/Howto/Write_an_api_reference" class="button submenu-item"><span>中文 (简体)</span></a></li></ul></div></div></li></ul></div></div></div></div><div class="container"><div class="notecard localized-content-note"><p><a href="/ja/docs/MDN/Community/Contributing/Translated_content#アクティブなロケール">このページはコミュニティーの尽力で英語から翻訳されました。MDN Web Docs コミュニティーについてもっと知り、仲間になるにはこちらから。</a></p></div></div><div class="main-wrapper"><div class="sidebar-container"><aside id="sidebar-quicklinks" class="sidebar" data-macro="mdnsidebar"><button type="button" class="button action backdrop" aria-label="Collapse sidebar"><span class="button-wrap"></span></button><nav aria-label="Related Topics" class="sidebar-inner"><header class="sidebar-actions"><section class="sidebar-filter-container"><div class="sidebar-filter "><label id="sidebar-filter-label" class="sidebar-filter-label" for="sidebar-filter-input"><span class="icon icon-filter"></span><span class="visually-hidden">Filter sidebar</span></label><input id="sidebar-filter-input" autoComplete="off" class="sidebar-filter-input-field false" type="text" placeholder="Filter" value=""/><button type="button" class="button action has-icon clear-sidebar-filter-button"><span class="button-wrap"><span class="icon icon-cancel "></span><span class="visually-hidden">Clear filter input</span></span></button></div></section></header><div class="sidebar-inner-nav"><div class="in-nav-toc"><div class="document-toc-container"><section class="document-toc"><header><h2 class="document-toc-heading">この記事では</h2></header><ul class="document-toc-list"><li class="document-toc-item "><a class="document-toc-link" href="#準備">準備</a></li><li class="document-toc-item "><a class="document-toc-link" href="#ページの作成">ページの作成</a></li><li class="document-toc-item "><a class="document-toc-link" href="#サイドバー">サイドバー</a></li></ul></section></div></div><div class="sidebar-body"><ol><li class="section"><a href="/ja/docs/MDN">MDN Web Docs プロジェクト</a></li><li><a href="/ja/docs/MDN/Tutorials">チュートリアル</a></li><li><a href="/ja/docs/MDN/Guides">開発者ガイド</a></li><li class="toggle"><details><summary>Community resources</summary><ol><li><a href="/ja/docs/MDN/Community">コミュニティガイドライン</a></li><li><a href="/ja/docs/MDN/Community/Getting_started">MDN を始めよう</a></li><li><a href="/ja/docs/MDN/Community/Our_repositories">MDN Web Docs のリポジトリー</a></li><li><a href="/ja/docs/MDN/Community/Open_source_etiquette">オープンソースのエチケット</a></li><li><a href="/ja/docs/MDN/Community/Issues">課題の作成と作業のガイドライン</a></li><li><a href="/ja/docs/MDN/Community/Pull_requests">プルリクエストの提出とレビューのガイドライン</a></li><li><a href="/ja/docs/MDN/Community/Discussions">コミュニティのディスカッション</a></li><li><a href="/ja/docs/MDN/Community/Translated_content">MDN Web Docs のローカライズ</a></li><li><a href="/ja/docs/MDN/Community/Roles_teams">MDN Web Docs の役割とチーム</a></li><li><a href="/ja/docs/MDN/Community/Communication_channels">コミュニケーション手段</a></li><li><a href="/ja/docs/MDN/Community/Learn_forum">学習フォーラム</a></li></ol></details></li><li class="toggle"><details open=""><summary>Writing guidelines</summary><ol><li><a href="/ja/docs/MDN/Writing_guidelines">執筆ガイドライン</a></li><li><a href="/ja/docs/MDN/Writing_guidelines/What_we_write">私たちが書くもの</a></li><li><a href="/ja/docs/MDN/Writing_guidelines/Writing_style_guide">執筆スタイルガイド</a></li><li><a href="/en-US/docs/MDN/Writing_guidelines/Learning_content" class="only-in-en-us">Learning content guidelines</a></li><li><a href="/ja/docs/MDN/Writing_guidelines/Experimental_deprecated_obsolete">実験的、非推奨、廃止</a></li><li><a href="/ja/docs/MDN/Writing_guidelines/Attrib_copyright_license">帰属表示と著作権使用許諾</a></li><li class="toggle"><details open=""><summary>How-to guides</summary><ol><li><a href="/ja/docs/MDN/Writing_guidelines/Howto">の概要</a></li><li><a href="/ja/docs/MDN/Writing_guidelines/Howto/Write_a_new_entry_in_the_glossary">用語集の項目を執筆する方法</a></li><li><a href="/ja/docs/MDN/Writing_guidelines/Howto/Images_media">画像やメディアの追加方法</a></li><li><a href="/ja/docs/MDN/Writing_guidelines/Howto/Creating_moving_deleting">ページの作成、移動、削除、編集方法</a></li><li><a href="/ja/docs/MDN/Writing_guidelines/Howto/Document_a_CSS_property">CSS プロパティの記事の作成方法</a></li><li><a href="/ja/docs/MDN/Writing_guidelines/Howto/Document_an_HTTP_header">HTTP ヘッダーの記事の作成方法</a></li><li><a href="/ja/docs/MDN/Writing_guidelines/Howto/Document_web_errors">ウェブのエラー記事の作成方法</a></li><li><a href="/ja/docs/MDN/Writing_guidelines/Howto/Research_technology">技術の調査方法</a></li><li><a href="/ja/docs/MDN/Writing_guidelines/Howto/JSON_Structured_data">構造化データの使用方法</a></li><li><em><a href="/ja/docs/MDN/Writing_guidelines/Howto/Write_an_api_reference" aria-current="page">API リファレンスの書き方</a></em></li><li><a href="/ja/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN">Markdown の書き方</a></li></ol></details></li><li class="toggle"><details><summary>Page structures</summary><ol><li><a href="/ja/docs/MDN/Writing_guidelines/Page_structures">の概要</a></li><li><a href="/ja/docs/MDN/Writing_guidelines/Page_structures/Banners_and_notices">バナーと注意</a></li><li><a href="/ja/docs/MDN/Writing_guidelines/Page_structures/Code_examples">コードサンプル</a></li><li><a href="/ja/docs/MDN/Writing_guidelines/Page_structures/Compatibility_tables">互換性一覧表とブラウザー互換性データリポジトリー (BCD)</a></li><li><a href="/ja/docs/MDN/Writing_guidelines/Page_structures/Feature_status">機能状態</a></li><li><a href="/ja/docs/MDN/Writing_guidelines/Page_structures/Links">リンクマクロ</a></li><li><a href="/ja/docs/MDN/Writing_guidelines/Page_structures/Live_samples">ライブサンプル</a></li><li><a href="/ja/docs/MDN/Writing_guidelines/Page_structures/Page_types">ページの種類</a></li><li><a href="/ja/docs/MDN/Writing_guidelines/Page_structures/Sidebars">サイドバー</a></li><li><a href="/ja/docs/MDN/Writing_guidelines/Page_structures/Specification_tables">仕様書一覧表</a></li><li><a href="/ja/docs/MDN/Writing_guidelines/Page_structures/Syntax_sections">構文の節</a></li><li><a href="/ja/docs/MDN/Writing_guidelines/Page_structures/Macros">マクロの使用</a></li></ol></details></li></ol></details></li></ol></div></div><section class="place side"></section></nav></aside><div class="toc-container"><aside class="toc"><nav><div class="document-toc-container"><section class="document-toc"><header><h2 class="document-toc-heading">この記事では</h2></header><ul class="document-toc-list"><li class="document-toc-item "><a class="document-toc-link" href="#準備">準備</a></li><li class="document-toc-item "><a class="document-toc-link" href="#ページの作成">ページの作成</a></li><li class="document-toc-item "><a class="document-toc-link" href="#サイドバー">サイドバー</a></li></ul></section></div></nav></aside><section class="place side"></section></div></div><main id="content" class="main-content "><article class="main-page-content" lang="ja"><header><h1>API リファレンスの書き方</h1></header><div class="section-content"><p>このガイドでは、 MDN で API リファレンスを書くために必要なすべてのことを説明します。</p></div><section aria-labelledby="準備"><h2 id="準備"><a href="#準備">準備</a></h2><div class="section-content"><p>API の記事を書き始める前に、実際に書き始める前に準備・計画しておくべきことがいくつかあります。</p></div></section><section aria-labelledby="前提知識"><h3 id="前提知識"><a href="#前提知識">前提知識</a></h3><div class="section-content"><p>このガイドを読む前に、相応の知識を持っていることを前提としています。</p> <ul> <li>HTML、CSS、JavaScript などのウェブ技術。特に JavaScript は重要です。</li> <li>ウェブ技術の仕様書の読み方。 API を文書化する際に、これらの仕様書をよく見ることになるでしょう。</li> </ul> <p>それ以外のことは、その過程で学ぶことができます。</p></div></section><section aria-labelledby="前提条件となるリソース"><h3 id="前提条件となるリソース"><a href="#前提条件となるリソース">前提条件となるリソース</a></h3><div class="section-content"><p>API の文書化を始める前に、利用可能なものを用意しておく必要があります。</p> <ol> <li> <p>最新の仕様書: W3C 勧告であれ、初期の編集者草案であれ、その機能をカバーする（またはカバーすることを指定する）仕様書の利用可能な最新の草案を参照する必要があります。それを見つけるには、通常、ウェブ検索を行います。最新版は、多くの場合、その仕様書のすべての版からリンクされており、 "latest draft" などとリストアップされているはずです。</p> </li> <li> <p>最新のウェブブラウザー: これらは、 <a href="https://www.mozilla.org/ja/firefox/channel/desktop/" class="external" target="_blank">Firefox Nightly</a>/<a href="https://www.google.com/intl/en/chrome/canary/" class="external" target="_blank">Chrome Canary</a> などの実験的/アルファビルドであるべきで、文書化しようとしている機能に対応している可能性がより高いものです。これは、特に新しい/実験的な機能を文書化する場合に適切です。</p> </li> <li> <p>デモ/ブログ記事/その他の情報: できるだけ多くの情報を見つけてください。</p> </li> <li> <p>有用な技術連絡先: 仕様について質問できる親切な技術者、 API の標準化やブラウザーへの実装に携わっている人を見つけると本当に有益です。そのような人を探すのに良い場所には下記のものがあります。</p> <ul> <li>あなたが関連企業に勤めている場合、社内アドレス帳。</li> <li>その API の議論に関与している公開メーリングリスト。例えば Mozilla の <a href="https://groups.google.com/a/mozilla.org/g/dev-platform/" class="external" target="_blank">dev-platform</a> リストや W3C の <a href="https://lists.w3.org/Archives/Public/public-webapps/" class="external" target="_blank">public-webapps</a> リストなど。</li> <li>仕様書そのもの。例えば、 <a href="https://webaudio.github.io/web-audio-api/" class="external" target="_blank">Web Audio API 仕様書</a>には、冒頭に作者とその連絡先が記載されています。</li> </ul> </li> </ol></div></section><section aria-labelledby="時間をかけて_api_を使ってみる"><h3 id="時間をかけて_api_を使ってみる"><a href="#時間をかけて_api_を使ってみる">時間をかけて API を使ってみる</a></h3><div class="section-content"><p>API を文書化する過程で、何度もデモを作ることになるでしょう。しかし、 API がどのように動作するかに慣れることから始めるのが有効です。主なインターフェイス、プロパティ、メソッドは何か、主な用途は何か、そしてそれを使って簡単な機能を書く方法を学びましょう。</p> <p>API が変更された場合、参考にしたり学んだりする既存のデモが古くなっていないか注意する必要があります。デモで使われている主な構成要素が、最新の仕様と一致しているかどうかを確認してください。また、最新のブラウザーでは動作しないかもしれませんが、後方互換性のために古い機能に対応し続けていることが多いので、これはあまり信頼できるテストではありません。</p> <div class="notecard note"> <p><strong>メモ:</strong> 最近仕様が更新され。例えばあるメソッドの定義が変わったが、古いメソッドがまだブラウザーで動作する場合、古いメソッドと新しいメソッドをカバーするために、同じ場所で両方の記事を作成しなければならないことがよくあります。困ったときは、見つけたデモを参考にしたり、担当のエンジニアに聞いたりしてください。</p> </div></div></section><section aria-labelledby="執筆や更新が必要な記事のリストを作成する"><h3 id="執筆や更新が必要な記事のリストを作成する"><a href="#執筆や更新が必要な記事のリストを作成する">執筆や更新が必要な記事のリストを作成する</a></h3><div class="section-content"><p>API リファレンスには、一般的に次のようなページが含まれます。各ページの内容。例、テンプレートの詳細は、<a href="/ja/docs/MDN/Writing_guidelines/Page_structures/Page_types">ページの種類</a>の記事で確認することができます。作業を始める前に、作成すべきすべてのページのリストを書き出してください。</p> <ol> <li>概要ページ</li> <li>インターフェイスページ</li> <li>コンストラクターページ</li> <li>メソッドページ</li> <li>プロパティページ</li> <li>イベントページ</li> <li>概念/ガイドページ</li> <li>例</li> </ol> <div class="notecard note"> <p><strong>メモ:</strong> この記事では。例として<a href="/ja/docs/Web/API/Web_Audio_API">ウェブオーディオ API</a>を参照します。</p> </div> <h4 id="概要ページ">概要ページ</h4> <p>API の概要ページは、 API の役割、最上位のインターフェイス、他のインターフェイスに含まれる関連機能、その他の高水準な詳細を説明するために使われます。名前とスラッグは API の名前と最後に "API" を付けたものとしてください。 API リファレンスの最上位に置かれ、<a href="/ja/docs/Web/API">https://developer.mozilla.org/ja/docs/Web/API</a>の子として扱われます。</p> <p>例:</p> <ul> <li>Title: <em>ウェブオーディオ API</em></li> <li>Slug: <em>Web_Audio_API</em></li> <li>URL: <a href="/ja/docs/Web/API/Web_Audio_API">https://developer.mozilla.org/ja/docs/Web/API/Web_Audio_API</a></li> </ul> <h4 id="インターフェイスページ">インターフェイスページ</h4> <p>各インターフェイスは、インターフェイスの目的を説明し、メンバー（コンストラクター、メソッド、プロパティなど）をリストアップし、どのブラウザーと互換性があるかを示す、独自のページがあります。ページの名前とスラッグは、仕様書に書かれているとおりのインターフェイスの名前でなければなりません。各ページは、 API リファレンスの最上位に、 <a href="/ja/docs/Web/API">https://developer.mozilla.org/ja/docs/Web/API</a> の子として配置されます。</p> <p>例:</p> <ul> <li>Title: <em>AudioContext</em></li> <li>Slug: <em>AudioContext</em></li> <li>URL: <a href="/ja/docs/Web/API/AudioContext">https://developer.mozilla.org/ja/docs/Web/API/AudioContext</a></li> </ul>  <ul> <li>Title: <em>AudioNode</em></li> <li>Slug: <em>AudioNode</em></li> <li>URL: <a href="/ja/docs/Web/API/AudioNode">https://developer.mozilla.org/ja/docs/Web/API/AudioNode</a></li> </ul> <div class="notecard note"> <p><strong>メモ:</strong> インターフェイスに登場するメンバーはすべて文書化します。以下のルールに留意してください。</p> </div> <ul> <li>このインターフェイスを実装したオブジェクトのプロトタイプ上で定義されているメソッド（インスタンスメソッド）と、実際のクラス自身で定義されるメソッド（静的メソッド）を文書化します。まれに同じインターフェイスに両方が存在する場合は、ページ内で別々の節に（静的メソッド／インスタンスメソッドとして）記載します。通常はインスタンスメソッドしか存在しないので、その場合は「メソッド」というタイトルで記載します。</li> <li>継承されたプロパティやメソッドは、それぞれの親インターフェイスに掲載されているので文書化しません。しかし、その存在を示唆することはあります。</li> <li>ミックスインで定義されたプロパティやメソッドの記事を作成します。詳しくは<a href="/ja/docs/MDN/Writing_guidelines/Howto/Write_an_api_reference/Information_contained_in_a_WebIDL_file#mixin">ミックスインの協力ガイド</a>を参照してください。</li> <li>文字列化 (<code>toString()</code>) や JSON 化 (<code>toJSON()</code>) のような特殊なメソッドも、存在する場合は掲載します。</li> <li>名前の付いたコンストラクター（<a href="/ja/docs/Web/API/HTMLImageElement"><code>HTMLImageElement</code></a> における <code>Image()</code> など）も、関連があれば掲載します。</li> </ul> <h4 id="コンストラクターページ">コンストラクターページ</h4> <p>各インターフェイスには 0 個または 1 個のコンストラクターがあり、インターフェイスのページのサブページで文書化されています。コンストラクターの目的を説明し、その構文がどのようなものか、使用例、ブラウザーの互換性情報などを表示します。スラッグはコンストラクターの名前で、インターフェイス名と全く同じです。タイトルはインターフェイス名、ドット、コンストラクター名、そして最後に括弧を置きます。</p> <p>例:</p> <ul> <li>Title: <em>AudioContext.AudioContext()</em></li> <li>Slug: <em>AudioContext</em></li> <li>URL: <a href="/ja/docs/Web/API/AudioContext/AudioContext">https://developer.mozilla.org/ja/docs/Web/API/AudioContext/AudioContext</a></li> </ul> <h4 id="プロパティページ">プロパティページ</h4> <p>各インターフェイスには 0 個以上のプロパティがあり、インターフェイスのページのサブページで説明されています。各ページでは、そのプロパティの目的、構文の様子、使用例、ブラウザーの互換性情報などが説明されています。スラッグはプロパティの名前であり、タイトルはインターフェイス名、ドット、プロパティ名の順になります。</p> <p>例:</p> <ul> <li>Title: <em>AudioContext.state</em></li> <li>Slug: <em>state</em></li> <li>URL: <a href="/ja/docs/Web/API/BaseAudioContext/state">https://developer.mozilla.org/ja/docs/Web/API/AudioContext/state</a></li> </ul>  <h4 id="メソッドページ">メソッドページ</h4> <p>各インターフェイスには 0 個以上のメソッドがあり、インターフェイスのページのサブページで文書化されています。各ページでは、メソッドの目的を説明し、その構文がどのようなものか、使用例、ブラウザーの互換性情報などを示しています。スラッグはメソッドの名前であり、タイトルはインターフェイス名、ドット、メソッド名、括弧の順です。</p> <p>例:</p> <ul> <li>Title: <em>AudioContext.close()</em></li> <li>Slug: <em>close</em></li> <li>URL: <a href="/ja/docs/Web/API/AudioContext/close">https://developer.mozilla.org/ja/docs/Web/API/AudioContext/close</a></li> </ul>  <ul> <li>Title: <em>AudioContext.createGain()</em></li> <li>Slug: <em>createGain</em></li> <li>URL: <a href="/ja/docs/Web/API/BaseAudioContext/createGain">https://developer.mozilla.org/ja/docs/Web/API/AudioContext/createGain</a></li> </ul> <h4 id="イベントページ">イベントページ</h4> <p>イベントはターゲットのインターフェイスのサブページとして文書化し、スラッグは <em>イベント名</em>_event、タイトルは <code>インターフェイス: eventName イベント</code> としてください。</p> <p><code>on</code> イベントハンドラープロパティのページを作成しないでください。 <code>eventName_イベント</code> のページで、イベントにアクセスする両方の方法について説明してください。</p> <p>例:</p> <ul> <li>Title: XRSession: end イベント</li> <li>Slug: end_event</li> <li>URL: <a href="/en-US/docs/Web/API/XRSession/end_event" class="only-in-en-us">https://developer.mozilla.org/ja/docs/Web/XRSession/end_event</a></li> </ul> <h4 id="概念ガイドページ">概念/ガイドページ</h4> <p>ほとんどの API リファレンスには少なくとも 1 つのガイドがあり、時にはそれに付随する概念ページもあります。最低でも API リファレンスには「<em>API 名</em> の使用」というガイドがあるべきで、これは API の使い方の基本的なガイドを提供するものです。より複雑な API では、 API の異なる側面の使い方を説明するために、複数の使用法ガイドが必要になるかもしれません。</p> <p>必要であれば、「<em>API 名</em> の概念」という概念記事も含めることができます。この記事では、 API を効果的に使うために開発者が理解しておくべき、 API に関連する概念の背後にある理論を説明します。</p> <p>これらの記事はすべて、 API 概要ページのサブページとして作成する必要があります。例えば、ウェブオーディオには 4 つのガイドと 1 つの概念の記事があります。</p> <ul> <li><a href="/ja/docs/Web/API/Web_Audio_API/Using_Web_Audio_API">https://developer.mozilla.org/ja/docs/Web/API/Web_Audio_API/Using_Web_Audio_API</a></li> <li><a href="/ja/docs/Web/API/Web_Audio_API/Visualizations_with_Web_Audio_API">https://developer.mozilla.org/ja/docs/Web/API/Web_Audio_API/Visualizations_with_Web_Audio_API</a></li> <li><a href="/ja/docs/Web/API/Web_Audio_API/Web_audio_spatialization_basics">https://developer.mozilla.org/ja/docs/Web/API/Web_Audio_API/Web_audio_spatialization_basics</a></li> <li><a href="/ja/docs/Web/API/Web_Audio_API/Basic_concepts_behind_Web_Audio_API">https://developer.mozilla.org/ja/docs/Web/API/Web_Audio_API/Basic_concepts_behind_Web_Audio_API</a></li> </ul> <h4 id="例">例</h4> <p>少なくとも、 API の最も一般的な使用例を示すいくつかの例を作成する必要があります。これらは適切な場所に置くことができますが、推奨される場所は <a href="https://github.com/mdn/" class="external" target="_blank">MDN の GitHub リポジトリー</a>です。</p> <h4 id="全体の一覧の作成">全体の一覧の作成</h4> <p>これらのサブページの一覧を作成すると、追跡するために便利です。例えば次のようにします。</p> <ul> <li> <p>Web_Audio_API</p> </li> <li> <p>AudioContext</p> <ul> <li>AudioContext.currentTime</li> <li>AudioContext.destination</li> <li>AudioContext.listener</li> <li>…</li> <li>AudioContext.createBuffer()</li> <li>AudioContext.createBufferSource()</li> <li>…</li> </ul> </li> <li> <p>AudioNode</p> <ul> <li>AudioNode.context</li> <li>AudioNode.numberOfInputs</li> <li>AudioNode.numberOfOutputs</li> <li>…</li> <li>AudioNode.connect(Param)</li> <li>…</li> </ul> </li> <li> <p>AudioParam</p> </li> <li> <p>Events (update list)</p> <ul> <li>start</li> <li>end</li> <li>…</li> </ul> </li> </ul> <p>リストの各インターフェイスは、 <code>https://developer.mozilla.org/ja/docs/Web/API</code> のサブページとして独立したページが作成されています。例えば、 <a href="/ja/docs/Web/API/AudioContext"><code>AudioContext</code></a> の記事は、<code>https://developer.mozilla.org/ja/docs/Web/API/AudioContext</code> の場所にあります。各<a href="#インターフェイスページ">インターフェイスページ</a>では、そのインターフェイスが何をするのかを説明し、そのインターフェイスを構成するメソッドとプロパティのリストを提供しています。そして、各メソッドとプロパティは、それがメンバーであるインターフェイスのサブページとして作成され、それ自身のページで文書化されます。例えば、 <a href="/ja/docs/Web/API/BaseAudioContext/currentTime"><code>BaseAudioContext/currentTime</code></a> は、 <code>https://developer.mozilla.org/ja/docs/Web/API/AudioContext/currentTime</code> で文書化されています。</p></div></section><section aria-labelledby="ページの作成"><h2 id="ページの作成"><a href="#ページの作成">ページの作成</a></h2><div class="section-content"><p>次に、以下の構造に従って必要なページを作成します。 <a href="https://github.com/mdn/content#adding-a-new-document" class="external" target="_blank">MDN の content の README</a> には、新しい記事を作成する手順が書かれています。また、<a href="/ja/docs/MDN/Writing_guidelines/Page_structures/Page_types">ページの種類</a>のガイドには、役に立つかもしれない例やページテンプレートが書かれています。</p></div></section><section aria-labelledby="概要ページの構成"><h3 id="概要ページの構成"><a href="#概要ページの構成">概要ページの構成</a></h3><div class="section-content"><p>API ランディングページは、 API の規模によって長さが大きく異なりますが、基本的にはどれも同じような機能を備えています。長いランディングページの例としては <a href="/ja/docs/Web/API/Web_Audio_API">https://developer.mozilla.org/ja/docs/Web/API/Web_Audio_API</a> を参照してください。</p> <p>ランディングページの特徴は、以下の通りです。</p> <ol> <li><strong>説明</strong>: ランディングページの最初の段落では、 API の包括的な目的を短く簡潔に説明する必要があります。</li> <li><strong>概要と用途の節</strong>: 次の節は、 "[name of API] concepts and usage" と題し、 API が提供する主な機能、解決する問題、動作方法などの概要を、高い水準で説明する必要があります。この節はかなり短くし、コードや特定の実装の詳細には触れないようにしてください。</li> <li><strong>インターフェイスの一覧</strong>: この節は、「[API 名] のインターフェイス」というタイトルで、 API を構成する各インターフェイスのリファレンスページへのリンクと、各インターフェイスの機能についての簡単な説明を提供します。新しいページを素早く作成する方法については、「{{domxref}} マクロを使用した他の API 機能の参照」を参照してください。</li> <li><strong>例</strong>: この節では、 API の簡単な使用例を 1 つか 2 つ示してください。</li> <li><strong>仕様書一覧表</strong>: ここに、仕様書の一覧表を入れる必要があります。詳しくは「仕様書参照表の作成」の節をご覧ください。</li> <li><strong>ブラウザーの互換性</strong>: ここに、ブラウザーの互換性一覧表を入れてください。詳しくは<a href="/ja/docs/MDN/Writing_guidelines/Page_structures/Compatibility_tables">互換性一覧表</a>をご覧ください。</li> <li><strong>関連情報</strong>: 「関連情報」の節には、 MDN （および外部）のチュートリアル、サンプル、ライブラリーなど、この技術について学ぶ際に役立つかもしれないさらなるリンクを含める野に良い場所です。</li> <li><strong>タグ</strong>: 各リファレンスページに含めるべき標準タグがあります。詳しくは「タグ」の節をご覧ください。</li> </ol></div></section><section aria-labelledby="インターフェイスページの構成"><h3 id="インターフェイスページの構成"><a href="#インターフェイスページの構成">インターフェイスページの構成</a></h3><div class="section-content"><p>これで、インターフェイスのページを書き始める準備が整ったはずです。各インターフェイスリファレンスページは、以下の構造を守る必要があります。</p> <ol> <li> <p><strong>{{APIRef}}</strong>: 各インターフェイスページの最初の行に {{APIRef}} マクロを置き、引数に API の名前を入れてください。例えば {{APIRef("Web Audio API")}} のようにします。このマクロは、インターフェイスページの左側にリファレンスメニューを作成します。このマクロはインターフェイスページの左側のリファレンスメニューを構築します。そこにはプロパティやメソッド、および <a href="https://github.com/mdn/content/blob/main/files/jsondata/GroupData.json" class="external" target="_blank">GroupData</a> マクロで定義されたその他のクイックリンクを含みます（既存の GroupData 項目に API を追加するか、まだリストにない場合は新しい項目を作成するよう誰かに依頼してください）。メニューは、以下のスクリーンショットのようなものになります。 <img src="/ja/docs/MDN/Writing_guidelines/Howto/Write_an_api_reference/apiref-links.png" alt="このスクリーンショットは、 APIRef マクロによって生成された、メソッドとプロパティの複数のサブリストを持つ OscillatorNode インターフェイスの垂直ナビゲーションメニューを示します。" width="302" height="384" loading="lazy"></p> </li> <li> <p><strong>機能状態</strong>: <a href="/ja/docs/MDN/Writing_guidelines/Page_structures/Feature_status#feature_status_page_banners">機能状態を示すバナー</a> （非推奨、標準外、実験的）が必要に応じて自動的に追加されます。そのために必要なことは、 <a href="/ja/docs/MDN/Writing_guidelines/Page_structures/Feature_status#how_to_add_or_update_feature_statuses">browser-compat-data リポジトリーの状態を更新</a>することです。</p> </li> <li> <p><strong>説明</strong>: インターフェイスページの最初の段落では、インターフェイスの包括的な目的を簡潔に説明する必要があります。追加の説明が必要な場合は、さらに数段落を含めるとよいでしょう。インターフェイスが実質的には辞書である場合、「インターフェイス」の代わりにその用語を使用する必要があります。</p> </li> <li> <p><strong>継承図:</strong> <a href="https://github.com/mdn/yari/blob/main/kumascript/macros/InheritanceDiagram.ejs" class="external" target="_blank"><code>{{InheritanceDiagram}}</code></a> マクロを使用して、このインターフェイスの SVG の継承図を埋め込みます。</p> </li> <li> <p><strong>プロパティの一覧、メソッドの一覧</strong>: これらの節は、「プロパティ」と「メソッド」というタイトルで、そのインターフェイスのそれぞれのプロパティ/メソッドのリファレンスページへのリンクと（{{domxref}} マクロを使用します）、それぞれのプロパティが何を行うかの説明を提供します。これらは<a href="/ja/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN#定義リスト">説明/定義リスト</a>を使用してマークアップしてください。それぞれの説明は短く簡潔にしてください。可能であれば 1 文で。他のページへのリンクを素早く作成する方法については、「{{domxref}} マクロによる他の API 機能の参照」を参照してください。</p> <p>それぞれの節の冒頭で、プロパティ/メソッドの一覧の前に、イタリック体で適切な文章を使用して継承を示してください。</p> <ul> <li><em>このインターフェイスは固有のプロパティを実装していませんが、 {{domxref("XYZ")}}, および {{domxref("XYZ2")}} からプロパティを継承しています。</em></li> <li><em>このインターフェイスには {{domxref("XYZ")}}, および {{domxref("XYZ2")}} から継承したプロパティもあります。</em></li> <li><em>このインターフェイスは固有のメソッドを実装していませんが、 {{domxref("XYZ")}}, および {{domxref("XYZ2")}} からメソッドを継承しています。</em></li> <li><em>このインターフェイスには {{domxref("XYZ")}}, および {{domxref("XYZ2")}} から継承したプロパティもあります。</em></li> </ul> <div class="notecard note"> <p><strong>メモ:</strong> 読み取り専用のプロパティには {{ReadOnlyInline}} マクロを、その {{domxref}} リンクと同じ行に設置すると、小さくてかっこいい「読み取り専用」バッジを生成します。（必要に応じて、{{experimentalInline}}, {{non-standard_Inline}}, {{deprecatedInline}} マクロの後に使用してください）。</p> </div> </li> <li> <p><strong>例</strong>: API の主要な機能の典型的な使用法を示すコードリストを入れてください。すべてのコードを列挙するのではなく、そのうちの興味深い部分のみを並べてください。完全なコードのリストを紹介する場合は。例の全体を含んだ <a href="https://github.com/" class="external" target="_blank">GitHub</a> リポジトリーを参照することができます。また、 <a href="https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site" class="external" target="_blank">GitHub gh-pages</a> の機能を使って作成したライブサンプルにリンクすることもできます（もちろん、クライアント側のコードしか使用していなければですが）。サンプルが視覚的であれば、MDN <a href="/ja/docs/MDN/Writing_guidelines/Page_structures/Live_samples">ライブサンプル</a> 機能を使ってページ内でライブ実行できるようにすることができます。</p> </li> <li> <p><strong>仕様書一覧表</strong>: ここに、仕様書一覧表を入れる必要があります。詳しくは「仕様書参照表の作成」の節をご覧ください。</p> </li> <li> <p><strong>ブラウザーの互換性</strong>: ここで、ブラウザーの互換性一覧表を入れる必要があります。詳しくは、<a href="/ja/docs/MDN/Writing_guidelines/Page_structures/Compatibility_tables">互換性一覧表</a>を参照してください。</p> </li> <li> <p><strong>ポリフィル</strong>: 適切であれば、この節に、 API を実装していないブラウザーでも使用できるようにするためのポリフィルのコードを提供してください。ポリフィルが存在しない、あるいは必要ない場合は、この節は完全に除外してください。</p> </li> <li> <p><strong>関連情報</strong>: 「関連情報」の節は、 MDN （および外部）のチュートリアル、サンプル、ライブラリーなど、この技術について学ぶときに役立つかもしれないさらなるリンクを置くのに良い場所です。私たちは外部ソースへのリンクに対して自由なポリシーを持っていますが、注意してください。</p> <ul> <li>MDN の他のページと同じ情報を持つページを加えないでください。代わりにそのページにリンクしてください。</li> <li>著者名を記載しないでください - 私たちは作家中立のドキュメントサイトです。ドキュメントにリンクすれば、そこに著者名が表示されます。</li> <li>ブログの記事は特に注意が必要です。古くなりがちだからですです（古い構文、間違った互換性情報）。メンテナンスされた文書にはない明確な付加価値がある場合のみ、リンクを張ってください。</li> <li>「詳しくは ... を参照してください」や「... をクリックしてください」のような動作動詞は使わないでください。読者が見ることができるかどうか、リンクをクリックできるかどうか（紙版のドキュメントのように）分からないからです。</li> </ul> </li> </ol> <h4 id="インターフェイスのページの例">インターフェイスのページの例</h4> <p>インターフェイスページの代表的な例を以下に示します。</p> <ul> <li><a href="/ja/docs/Web/API/Request"><code>Request</code></a> （<a href="/ja/docs/Web/API/Fetch_API">フェッチ API</a>）</li> <li><a href="/ja/docs/Web/API/SpeechSynthesis"><code>SpeechSynthesis</code></a> （<a href="/ja/docs/Web/API/Web_Speech_API">ウェブ音声 API</a>）</li> </ul></div></section><section aria-labelledby="プロパティページの構成"><h3 id="プロパティページの構成"><a href="#プロパティページの構成">プロパティページの構成</a></h3><div class="section-content"><p>プロパティページは、それらが実装されているインターフェイスのサブページとして作成してください。他のプロパティページの構造をコピーして、新しいページの基礎とします。</p> <p>プロパティページの名前は <code>インターフェイス.プロパティ名</code> という規則に従うように編集してください。</p> <p>プロパティページには以下の節が必要です。</p> <ol> <li> <p><strong>タイトル</strong>: ページのタイトルは、<strong>インターフェイス名.プロパティ名</strong> とする必要があります。インターフェイス名は大文字で始めなければなりません。 JavaScript ではインターフェイスはオブジェクトのプロトタイプに実装されますが、 <a href="/ja/docs/Web/JavaScript/Reference">JavaScript リファレンス</a>のようにタイトルに <code>.prototype.</code> を含めることはありません。</p> </li> <li> <p><strong>{{APIRef}}</strong>: 各プロパティページの最初の行に {{APIRef}} マクロを置き、引数に API の名前を入れてください。例えば {{APIRef("Web Audio API")}} のようにします。このマクロは、プロパティページの左側にリファレンスメニューを作成します。このマクロはプロパティページの左側のリファレンスメニューを構築します。そこにはプロパティやメソッド、および <a href="https://github.com/mdn/content/blob/main/files/jsondata/GroupData.json" class="external" target="_blank">GroupData</a> マクロで定義されたその他のクイックリンクを含みます（既存の GroupData 項目に API を追加するか、まだリストにない場合は新しい項目を作成するよう誰かに依頼してください）。メニューは、以下のスクリーンショットのようなものになります。 <img src="/ja/docs/MDN/Writing_guidelines/Howto/Write_an_api_reference/apiref-links.png" alt="このスクリーンショットは、 APIRef マクロによって生成された、メソッドとプロパティの複数のサブリストを持つ OscillatorNode インターフェイスの垂直ナビゲーションメニューを示します。" width="302" height="384" loading="lazy"></p> </li> <li> <p><strong>機能状態</strong>: <a href="/ja/docs/MDN/Writing_guidelines/Page_structures/Feature_status#feature_status_page_banners">機能状態を示すバナー</a> （非推奨、標準外、実験的）が必要に応じて自動的に追加されます。そのために必要なことは、 <a href="/ja/docs/MDN/Writing_guidelines/Page_structures/Feature_status#how_to_add_or_update_feature_statuses">browser-compat-data リポジトリーの状態を更新</a>することです。</p> </li> <li> <p><strong>説明</strong>: プロパティページの最初の段落には、そのプロパティの包括的な目的を短く簡潔に説明する必要があります。また、追加の説明が必要な場合は、さらにいくつかの段落を書くととよいでしょう。明らかに記述すべき追加情報は、その既定値/初期値、および読み取り専用かどうかです。最初の文の構成は、次のようにしなければなりません。</p> <dl> <dt id="読み取り専用のプロパティの場合"><a href="#読み取り専用のプロパティの場合">読み取り専用のプロパティの場合</a></dt> <dd> <p><strong><code>インターフェイス名.プロパティ</code></strong> は読み取り専用のプロパティで、 {{domxref("type")}} を返します…</p> </dd> <dt id="その他のプロパティの場合"><a href="#その他のプロパティの場合">その他のプロパティの場合</a></dt> <dd> <p><strong><code>インターフェイス名.プロパティ</code></strong> プロパティは {{domxref("type")}} 型で…</p> </dd> </dl> <div class="notecard note"> <p><strong>メモ:</strong> <code>インターフェイス名.プロパティ</code> は <code><code></code> の中に入れ、最初に使用される場合は太字 (<code><strong></code>) で記述してください。</p> </div> </li> <li> <p><strong>値</strong>: 値の節では、プロパティの値の説明を行います。これにはプロパティのデータ型と、それが何を表しているかを説明する必要があります。例として、 <a href="/ja/docs/Web/API/SpeechRecognition/grammars"><code>SpeechRecognition.grammars</code></a> を参照してください。</p> </li> <li> <p><strong>例</strong>: プロパティの典型的な使用方法を示すために、コードのリストを含めてください。その型のオブジェクトがどのように作成され、どのようにプロパティにアクセスするかを示す簡単な例から始める必要があります。より複雑な例は、そのような例の後に追加することができます。すべてのコードを列挙するのではなく、そのうちの興味深い部分のみを並べてください。完全なコードのリストを紹介する場合は。例の全体を含んだ <a href="https://github.com/" class="external" target="_blank">GitHub</a> リポジトリーを参照することができます。また、 <a href="https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site" class="external" target="_blank">GitHub gh-pages</a> の機能を使って作成したライブサンプルにリンクすることもできます（もちろん、クライアント側のコードしか使用していなければですが）。サンプルが視覚的であれば、MDN <a href="/ja/docs/MDN/Writing_guidelines/Page_structures/Live_samples">ライブサンプル</a> 機能を使ってページ内でライブ実行できるようにすることができます。</p> </li> <li> <p><strong>仕様書一覧表</strong>: ここに、仕様書一覧表を入れる必要があります。詳しくは「仕様書参照表の作成」の節をご覧ください。</p> </li> <li> <p><strong>ブラウザーの互換性</strong>: ここで、ブラウザーの互換性一覧表を入れる必要があります。詳しくは、<a href="/ja/docs/MDN/Writing_guidelines/Page_structures/Compatibility_tables">互換性一覧表</a>を参照してください。</p> </li> <li> <p><strong>関連情報</strong>: 「関連情報」の節は、この技術を使用する際に役立つかもしれないさらなるリンクを置くのに良い場所です。このプロパティの変更によって影響を受けるメソッドやプロパティ、またはそれに関連して発行されるイベントなどです。 MDN （および外部）のチュートリアル、サンプル、ライブラリーなど、この技術について学ぶ際に役立つリンクを追加することができますが、代わりにインターフェイスのリファレンスページに追加することを考慮すると便利かもしれません。</p> </li> </ol> <h4 id="プロパティページの例">プロパティページの例</h4> <p>以下に、プロパティページの例を示します。</p> <ul> <li><a href="/ja/docs/Web/API/Request/method"><code>Request.method</code></a> （<a href="/ja/docs/Web/API/Fetch_API">フェッチ API</a>）</li> <li><a href="/en-US/docs/Web/API/SpeechSynthesis/speaking" class="only-in-en-us"><code>SpeechSynthesis.speaking</code></a> （<a href="/ja/docs/Web/API/Web_Speech_API">ウェブ音声 API</a>）</li> </ul></div></section><section aria-labelledby="メソッドページの構成"><h3 id="メソッドページの構成"><a href="#メソッドページの構成">メソッドページの構成</a></h3><div class="section-content"><p>メソッドページは、実装されるインターフェイスのサブページとして作成してくあさい。他のメソッドページの構造をコピーして、新しいページの基礎とします。</p> <p>メソッドページには以下の節が必要です。</p> <ol> <li> <p><strong>タイトル</strong>: ページのタイトルは、<strong>インターフェイス名.メソッド名()</strong> （最後に 2 つの括弧つき）とする必要がありますが、スラッグ（ページ URL の最後）は括弧をつけてはいけません。また、インターフェイス名は大文字で始めなければなりません。 JavaScript ではインターフェイスはオブジェクトのプロトタイプに実装されますが、 <a href="/ja/docs/Web/JavaScript/Reference">JavaScript リファレンス</a>のようにタイトルに <code>.prototype.</code> を含めることはありません。</p> </li> <li> <p><strong>{{APIRef}}</strong>: 各メソッドページの最初の行に {{APIRef}} マクロを置き、引数に API の名前を入れてください。例えば {{APIRef("Web Audio API")}} のようにします。このマクロは、メソッドページの左側にリファレンスメニューを作成します。このマクロはインターフェイスページの左側のリファレンスメニューを構築します。そこにはプロパティやメソッド、および <a href="https://github.com/mdn/content/blob/main/files/jsondata/GroupData.json" class="external" target="_blank">GroupData</a> マクロで定義されたその他のクイックリンクを含みます（既存の GroupData 項目に API を追加するか、まだリストにない場合は新しい項目を作成するよう誰かに依頼してください）。メニューは、以下のスクリーンショットのようなものになります。 <img src="/ja/docs/MDN/Writing_guidelines/Howto/Write_an_api_reference/apiref-links.png" alt="このスクリーンショットは、 APIRef マクロによって生成された、メソッドとプロパティの複数のサブリストを持つ OscillatorNode インターフェイスの垂直ナビゲーションメニューを示します。" width="302" height="384" loading="lazy"></p> </li> <li> <p><strong>機能状態</strong>: <a href="/ja/docs/MDN/Writing_guidelines/Page_structures/Feature_status#feature_status_page_banners">機能状態を示すバナー</a> （非推奨、標準外、実験的）が必要に応じて自動的に追加されます。そのために必要なことは、 <a href="/ja/docs/MDN/Writing_guidelines/Page_structures/Feature_status#how_to_add_or_update_feature_statuses">browser-compat-data リポジトリーの状態を更新</a>することです。</p> </li> <li> <p><strong>説明</strong>: メソッドページの最初の段落には、そのメソッドの包括的な目的を短く簡潔に説明する必要があります。また、追加の説明が必要な場合は、さらにいくつかの段落を書くととよいでしょう。明らかに追加すべき情報は、デフォルト引数の値、そのメソッドが依存する理論、および引数値が行うことです。</p> <dl> <dt id="最初の文の冒頭は、次のような構成にしなければなりません。"><a href="#最初の文の冒頭は、次のような構成にしなければなりません。">最初の文の冒頭は、次のような構成にしなければなりません。</a></dt> <dd> <p><strong><code>インターフェイス名.メソッド名()</code></strong> メソッドインターフェイスは…</p> </dd> </dl> <div class="notecard note"> <p><strong>メモ:</strong> <code>インターフェイス名.メソッド名()</code> は <code><code></code> の中に入れ、最初に使用される場合は太字 (<code><strong></code>) で記述してください。</p> </div> </li> <li> <p><strong>構文</strong>: 構文の節には、 2 - 3 行の例（通常はインターフェイスの構築とインターフェイスメソッドの呼び出しのみ）を含める必要があります。</p> <dl> <dt id="構文は次の形式にしてください。"><a href="#構文は次の形式にしてください。">構文は次の形式にしてください。</a></dt> <dd> <p>method(param1, param2, …)</p> </dd> </dl> <p>構文の節には、以下の 3 つの項を入れてください（例として、 <a href="/ja/docs/Web/API/SubtleCrypto/sign"><code>SubtleCrypto.sign()</code></a> を参照してください）。</p> <ul> <li>"引数": これには、メソッドが受け取る様々な引数を命名・記述した定義リスト（または順不同のリスト）を置く必要があります。オプションの引数の場合、引数名の隣に <span class="badge inline optional">省略可</span> マクロを置く必要があります。引数がない場合、この項は省略してください。</li> <li>"返値": これはメソッドが持つ返値を示すもので、 double や論理値のような単純な値でも、別なインターフェイスのオブジェクトのような複雑な値でも構いません。この場合、 {{domxref}} マクロを使って、そのインターフェイスをカバーする MDN API ページに（存在すれば）リンクすることができます。メソッドは何も返さない場合がありますが、その場合、返値は "{{jsxref('undefined')}}" と記述します（レンダリングすると <a href="/ja/docs/Web/JavaScript/Reference/Global_Objects/undefined"><code>undefined</code></a> と表示されます）。</li> <li>"例外": これは、そのメソッドを呼び出したときに発生する可能性のあるさまざまな例外と、その例外を発生させる状況を列挙してください。例外が発生しない場合は、この節は省略してください。</li> </ul> </li> <li> <p><strong>例</strong>: プロパティの典型的な使用方法を示すために、コードのリストを入れてください。すべてのコードを列挙するのではなく、そのうちの興味深い部分のみを並べてください。完全なコードのリストを紹介する場合は。例の全体を含んだ <a href="https://github.com/" class="external" target="_blank">GitHub</a> リポジトリーを参照することができます。また、 <a href="https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site" class="external" target="_blank">GitHub gh-pages</a> の機能を使って作成したライブサンプルにリンクすることもできます（もちろん、クライアント側のコードしか使用していなければですが）。サンプルが視覚的であれば、MDN <a href="/ja/docs/MDN/Writing_guidelines/Page_structures/Live_samples">ライブサンプル</a> 機能を使ってページ内でライブ実行できるようにすることができます。</p> </li> <li> <p><strong>仕様書一覧表</strong>: ここに、仕様書一覧表を入れる必要があります。詳しくは「仕様書参照表の作成」の節をご覧ください。</p> </li> <li> <p><strong>ブラウザーの互換性</strong>: ここで、ブラウザーの互換性一覧表を入れる必要があります。詳しくは、<a href="/ja/docs/MDN/Writing_guidelines/Page_structures/Compatibility_tables">互換性一覧表</a>を参照してください。</p> </li> </ol> <h4 id="メソッドページの例">メソッドページの例</h4> <p>以下に、メソッドページの例を示します。</p> <ul> <li><a href="/ja/docs/Web/API/Document/getAnimations"><code>Document.getAnimations</code></a> （<a href="/ja/docs/Web/API/Web_Animations_API">ウェブアニメーション API</a>）</li> <li><a href="/ja/docs/Web/API/Window/fetch" title="fetch()"><code>fetch()</code></a> （<a href="/ja/docs/Web/API/Fetch_API">フェッチ API</a>）</li> </ul></div></section><section aria-labelledby="サイドバー"><h2 id="サイドバー"><a href="#サイドバー">サイドバー</a></h2><div class="section-content"><p>API リファレンスページを作成したら、ページを関連付けるために適切なサイドバーを挿入したくなるでしょう。 <a href="/ja/docs/MDN/Writing_guidelines/Howto/Write_an_api_reference/Sidebars">API リファレンスサイドバー</a>のガイドで、その方法を説明します。</p></div></section></article><aside class="article-footer"><div class="article-footer-inner"><div class="svg-container"><svg xmlns="http://www.w3.org/2000/svg" width="162" height="162" viewBox="0 0 162 162" fill="none" role="none"><mask id="b" fill="#fff"><path d="M97.203 47.04c8.113-7.886 18.004-13.871 28.906-17.492a78 78 0 0 1 33.969-3.39c11.443 1.39 22.401 5.295 32.024 11.411s17.656 14.28 23.476 23.86c5.819 9.579 9.269 20.318 10.083 31.385a69.85 69.85 0 0 1-5.387 32.44c-4.358 10.272-11.115 19.443-19.747 26.801-8.632 7.359-18.908 12.709-30.034 15.637l-6.17-21.698c7.666-2.017 14.746-5.703 20.694-10.773 5.948-5.071 10.603-11.389 13.606-18.467a48.14 48.14 0 0 0 3.712-22.352c-.561-7.625-2.938-15.025-6.948-21.625s-9.544-12.226-16.175-16.44-14.181-6.904-22.065-7.863a53.75 53.75 0 0 0-23.405 2.336c-7.513 2.495-14.327 6.62-19.918 12.053z"></path></mask><path stroke="url(#a)" stroke-dasharray="6, 6" stroke-width="2" d="M97.203 47.04c8.113-7.886 18.004-13.871 28.906-17.492a78 78 0 0 1 33.969-3.39c11.443 1.39 22.401 5.295 32.024 11.411s17.656 14.28 23.476 23.86c5.819 9.579 9.269 20.318 10.083 31.385a69.85 69.85 0 0 1-5.387 32.44c-4.358 10.272-11.115 19.443-19.747 26.801-8.632 7.359-18.908 12.709-30.034 15.637l-6.17-21.698c7.666-2.017 14.746-5.703 20.694-10.773 5.948-5.071 10.603-11.389 13.606-18.467a48.14 48.14 0 0 0 3.712-22.352c-.561-7.625-2.938-15.025-6.948-21.625s-9.544-12.226-16.175-16.44-14.181-6.904-22.065-7.863a53.75 53.75 0 0 0-23.405 2.336c-7.513 2.495-14.327 6.62-19.918 12.053z" mask="url(#b)" style="stroke:url(#a)" transform="translate(-63.992 -25.587)"></path><ellipse cx="8.066" cy="111.597" fill="var(--background-tertiary)" rx="53.677" ry="53.699" transform="matrix(.71707 -.697 .7243 .6895 0 0)"></ellipse><g clip-path="url(#c)" transform="translate(-63.992 -25.587)"><path fill="#9abff5" d="m144.256 137.379 32.906 12.434a4.41 4.41 0 0 1 2.559 5.667l-9.326 24.679a4.41 4.41 0 0 1-5.667 2.559l-8.226-3.108-2.332 6.17c-.466 1.233-.375 1.883-1.609 1.417l-2.253-.527c-.411-.155-.95-.594-1.206-1.161l-4.734-10.484-12.545-4.741a4.41 4.41 0 0 1-2.559-5.667l9.325-24.679a4.41 4.41 0 0 1 5.667-2.559m9.961 29.617 8.227 3.108 3.264-8.638-.498-6.768-4.113-1.555.548 7.258-4.319-1.632zm-12.339-4.663 8.226 3.108 3.264-8.637-.498-6.769-4.113-1.554.548 7.257-4.319-1.632z"></path></g><g clip-path="url(#d)" transform="translate(-63.992 -25.587)"><path fill="#81b0f3" d="M135.35 60.136 86.67 41.654c-3.346-1.27-7.124.428-8.394 3.775L64.414 81.938c-1.27 3.347.428 7.125 3.774 8.395l12.17 4.62-3.465 9.128c-.693 1.826-1.432 2.457.394 3.15l3.014 1.625c.609.231 1.637.274 2.477-.104l15.53-6.983 18.56 7.047c3.346 1.27 7.124-.428 8.395-3.775l13.862-36.51c1.27-3.346-.428-7.124-3.775-8.395M95.261 83.207l-12.17-4.62 4.852-12.779 7.19-7.017 6.085 2.31-7.725 7.51 6.389 2.426zm18.255 6.93-12.17-4.62 4.852-12.778 7.189-7.017 6.085 2.31-7.725 7.51 6.39 2.426z"></path></g><defs><clipPath id="c"><path fill="#fff" d="m198.638 146.586-65.056-24.583-24.583 65.057 65.056 24.582z"></path></clipPath><clipPath id="d"><path fill="#fff" d="m66.438 14.055 96.242 36.54-36.54 96.243-96.243-36.54z"></path></clipPath><linearGradient id="a" x1="97.203" x2="199.995" y1="47.04" y2="152.793" gradientUnits="userSpaceOnUse"><stop stop-color="#086DFC"></stop><stop offset="0.246" stop-color="#2C81FA"></stop><stop offset="0.516" stop-color="#5497F8"></stop><stop offset="0.821" stop-color="#80B0F6"></stop><stop offset="1" stop-color="#9ABFF5"></stop></linearGradient></defs></svg></div><h2>Help improve MDN</h2><fieldset class="feedback"><label>Was this page helpful to you?</label><div class="button-container"><button type="button" class="button primary has-icon yes"><span class="button-wrap"><span class="icon icon-thumbs-up "></span>Yes</span></button><button type="button" class="button primary has-icon no"><span class="button-wrap"><span class="icon icon-thumbs-down "></span>No</span></button></div></fieldset><a class="contribute" href="https://github.com/mdn/translated-content/blob/main/CONTRIBUTING.md" title="This will take you to our contribution guidelines on GitHub." target="_blank" rel="noopener noreferrer">Learn how to contribute</a>.<p class="last-modified-date">This page was last modified on <time dateTime="2024-12-17T09:38:13.000Z">2024年12月17日</time> by <a href="/ja/docs/MDN/Writing_guidelines/Howto/Write_an_api_reference/contributors.txt" rel="nofollow">MDN contributors</a>.</p><div id="on-github" class="on-github"><a href="https://github.com/mdn/translated-content/blob/main/files/ja/mdn/writing_guidelines/howto/write_an_api_reference/index.md?plain=1" title="Folder: ja/mdn/writing_guidelines/howto/write_an_api_reference (Opens in a new tab)" target="_blank" rel="noopener noreferrer">View this page on GitHub</a> • <a href="https://github.com/mdn/translated-content/issues/new?template=page-report-ja.yml&mdn-url=https%3A%2F%2Fdeveloper.mozilla.org%2Fja%2Fdocs%2FMDN%2FWriting_guidelines%2FHowto%2FWrite_an_api_reference&metadata=%3C%21--+Do+not+make+changes+below+this+line+--%3E%0A%3Cdetails%3E%0A%3Csummary%3EPage+report+details%3C%2Fsummary%3E%0A%0A*+Folder%3A+%60ja%2Fmdn%2Fwriting_guidelines%2Fhowto%2Fwrite_an_api_reference%60%0A*+MDN+URL%3A+https%3A%2F%2Fdeveloper.mozilla.org%2Fja%2Fdocs%2FMDN%2FWriting_guidelines%2FHowto%2FWrite_an_api_reference%0A*+GitHub+URL%3A+https%3A%2F%2Fgithub.com%2Fmdn%2Ftranslated-content%2Fblob%2Fmain%2Ffiles%2Fja%2Fmdn%2Fwriting_guidelines%2Fhowto%2Fwrite_an_api_reference%2Findex.md%0A*+Last+commit%3A+https%3A%2F%2Fgithub.com%2Fmdn%2Ftranslated-content%2Fcommit%2F24c3a40584d521462c0a49f6f7cc01328c1a437f%0A*+Document+last+modified%3A+2024-12-17T09%3A38%3A13.000Z%0A%0A%3C%2Fdetails%3E" title="This will take you to GitHub to file a new issue." target="_blank" rel="noopener noreferrer">Report a problem with this content</a></div></div></aside></main></div></div><footer id="nav-footer" class="page-footer"><div class="page-footer-grid"><div class="page-footer-logo-col"><a href="/" class="mdn-footer-logo" aria-label="MDN homepage"><svg width="48" height="17" viewBox="0 0 48 17" fill="none" xmlns="http://www.w3.org/2000/svg"><title id="mdn-footer-logo-svg">MDN logo</title><path d="M20.04 16.512H15.504V10.416C15.504 9.488 15.344 8.824 15.024 8.424C14.72 8.024 14.264 7.824 13.656 7.824C12.92 7.824 12.384 8.064 12.048 8.544C11.728 9.024 11.568 9.64 11.568 10.392V14.184H13.008V16.512H8.472V10.416C8.472 9.488 8.312 8.824 7.992 8.424C7.688 8.024 7.232 7.824 6.624 7.824C5.872 7.824 5.336 8.064 5.016 8.544C4.696 9.024 4.536 9.64 4.536 10.392V14.184H6.6V16.512H0V14.184H1.44V8.04H0.024V5.688H4.536V7.32C5.224 6.088 6.32 5.472 7.824 5.472C8.608 5.472 9.328 5.664 9.984 6.048C10.64 6.432 11.096 7.016 11.352 7.8C11.992 6.248 13.168 5.472 14.88 5.472C15.856 5.472 16.72 5.776 17.472 6.384C18.224 6.992 18.6 7.936 18.6 9.216V14.184H20.04V16.512Z" fill="currentColor"></path><path d="M33.6714 16.512H29.1354V14.496C28.8314 15.12 28.3834 15.656 27.7914 16.104C27.1994 16.536 26.4154 16.752 25.4394 16.752C24.0154 16.752 22.8954 16.264 22.0794 15.288C21.2634 14.312 20.8554 12.984 20.8554 11.304C20.8554 9.688 21.2554 8.312 22.0554 7.176C22.8554 6.04 24.0634 5.472 25.6794 5.472C26.5594 5.472 27.2794 5.648 27.8394 6C28.3994 6.352 28.8314 6.8 29.1354 7.344V2.352H26.9754V0H32.2314V14.184H33.6714V16.512ZM29.1354 11.04V10.776C29.1354 9.88 28.8954 9.184 28.4154 8.688C27.9514 8.176 27.3674 7.92 26.6634 7.92C25.9754 7.92 25.3674 8.176 24.8394 8.688C24.3274 9.2 24.0714 10.008 24.0714 11.112C24.0714 12.152 24.3114 12.944 24.7914 13.488C25.2714 14.032 25.8394 14.304 26.4954 14.304C27.3114 14.304 27.9514 13.96 28.4154 13.272C28.8954 12.584 29.1354 11.84 29.1354 11.04Z" fill="currentColor"></path><path d="M47.9589 16.512H41.9829V14.184H43.4229V10.416C43.4229 9.488 43.2629 8.824 42.9429 8.424C42.6389 8.024 42.1829 7.824 41.5749 7.824C40.8389 7.824 40.2709 8.056 39.8709 8.52C39.4709 8.968 39.2629 9.56 39.2469 10.296V14.184H40.6869V16.512H34.7109V14.184H36.1509V8.04H34.5909V5.688H39.2469V7.344C39.9669 6.096 41.1269 5.472 42.7269 5.472C43.7509 5.472 44.6389 5.776 45.3909 6.384C46.1429 6.992 46.5189 7.936 46.5189 9.216V14.184H47.9589V16.512Z" fill="currentColor"></path></svg></a><p>Your blueprint for a better internet.</p><ul class="social-icons"><li><a href="https://mastodon.social/@mdn" target="_blank" rel="me noopener noreferrer"><span class="icon icon-mastodon"></span><span class="visually-hidden">MDN on Mastodon</span></a></li><li><a href="https://twitter.com/mozdevnet" target="_blank" rel="noopener noreferrer"><span class="icon icon-twitter-x"></span><span class="visually-hidden">MDN on X (formerly Twitter)</span></a></li><li><a href="https://github.com/mdn/" target="_blank" rel="noopener noreferrer"><span class="icon icon-github-mark-small"></span><span class="visually-hidden">MDN on GitHub</span></a></li><li><a href="/en-US/blog/rss.xml" target="_blank"><span class="icon icon-feed"></span><span class="visually-hidden">MDN Blog RSS Feed</span></a></li></ul></div><div class="page-footer-nav-col-1"><h2 class="footer-nav-heading">MDN</h2><ul class="footer-nav-list"><li class="footer-nav-item"><a href="/en-US/about">About</a></li><li class="footer-nav-item"><a href="/en-US/blog/">Blog</a></li><li class="footer-nav-item"><a href="https://www.mozilla.org/en-US/careers/listings/?team=ProdOps" target="_blank" rel="noopener noreferrer">Careers</a></li><li class="footer-nav-item"><a href="/en-US/advertising">Advertise with us</a></li></ul></div><div class="page-footer-nav-col-2"><h2 class="footer-nav-heading">Support</h2><ul class="footer-nav-list"><li class="footer-nav-item"><a class="footer-nav-link" href="https://support.mozilla.org/products/mdn-plus">Product help</a></li><li class="footer-nav-item"><a class="footer-nav-link" href="/ja/docs/MDN/Community/Issues">Report an issue</a></li></ul></div><div class="page-footer-nav-col-3"><h2 class="footer-nav-heading">Our communities</h2><ul class="footer-nav-list"><li class="footer-nav-item"><a class="footer-nav-link" href="/en-US/community">MDN Community</a></li><li class="footer-nav-item"><a class="footer-nav-link" href="https://discourse.mozilla.org/c/mdn/236" target="_blank" rel="noopener noreferrer">MDN Forum</a></li><li class="footer-nav-item"><a class="footer-nav-link" href="/discord" target="_blank" rel="noopener noreferrer">MDN Chat</a></li></ul></div><div class="page-footer-nav-col-4"><h2 class="footer-nav-heading">Developers</h2><ul class="footer-nav-list"><li class="footer-nav-item"><a class="footer-nav-link" href="/ja/docs/Web">Web Technologies</a></li><li class="footer-nav-item"><a class="footer-nav-link" href="/ja/docs/Learn">Learn Web Development</a></li><li class="footer-nav-item"><a class="footer-nav-link" href="/ja/plus">MDN Plus</a></li><li class="footer-nav-item"><a href="https://hacks.mozilla.org/" target="_blank" rel="noopener noreferrer">Hacks Blog</a></li></ul></div><div class="page-footer-moz"><a href="https://www.mozilla.org/" class="footer-moz-logo-link" target="_blank" rel="noopener noreferrer"><svg xmlns="http://www.w3.org/2000/svg" width="137" height="32" fill="none" viewBox="0 0 267.431 62.607"><path fill="currentColor" d="m13.913 23.056 5.33 25.356h2.195l5.33-25.356h14.267v38.976h-7.578V29.694h-2.194l-7.264 32.337h-7.343L9.418 29.694H7.223v32.337H-.354V23.056Zm47.137 9.123c9.12 0 14.423 5.385 14.423 15.214s-5.33 15.214-14.423 15.214c-9.12 0-14.423-5.385-14.423-15.214 0-9.855 5.304-15.214 14.423-15.214m0 24.363c4.285 0 6.428-2.196 6.428-7.032v-4.287c0-4.836-2.143-7.032-6.428-7.032s-6.428 2.196-6.428 7.032v4.287c0 4.836 2.143 7.032 6.428 7.032m18.473-.157 15.47-18.01h-15.26v-5.647h24.352v5.646L88.616 56.385h15.704v5.646H79.523Zm29.318-23.657h11.183V62.03h-7.578V38.375h-3.632v-5.646zm3.605-9.672h7.578v5.646h-7.578zm13.17 0h11.21v38.976h-7.578v-33.33h-3.632zm16.801 0H153.6v38.976h-7.577v-33.33h-3.632v-5.646zm29.03 9.123c4.442 0 7.394 2.143 8.231 5.881h2.194v-5.332h9.276v5.646h-3.632v18.011h3.632v5.646h-4.442c-3.135 0-4.834-1.699-4.834-4.836V56.7h-2.194c-.81 3.738-3.789 5.881-8.23 5.881-6.978 0-11.916-5.829-11.916-15.214 0-9.384 4.938-15.187 11.915-15.187m2.3 24.363c4.284 0 6.192-2.196 6.192-7.032v-4.287c0-4.836-1.908-7.032-6.193-7.032-4.18 0-6.193 2.196-6.193 7.032v4.287c0 4.836 2.012 7.032 6.193 7.032m48.34 5.489h-7.577V0h7.577zm6.585-29.643h32.165v-2.196l-21.295-7.634v-6.143l21.295-7.633V6.588h-25.345V0h32.165v12.522l-17.35 5.881V20.6l17.35 5.882v12.521h-38.985zm0-25.801h6.794v6.796h-6.794z"></path></svg></a><ul class="footer-moz-list"><li class="footer-moz-item"><a href="https://www.mozilla.org/privacy/websites/" class="footer-moz-link" target="_blank" rel="noopener noreferrer">Website Privacy Notice</a></li><li class="footer-moz-item"><a href="https://www.mozilla.org/privacy/websites/#cookies" class="footer-moz-link" target="_blank" rel="noopener noreferrer">Cookies</a></li><li class="footer-moz-item"><a href="https://www.mozilla.org/about/legal/terms/mozilla" class="footer-moz-link" target="_blank" rel="noopener noreferrer">Legal</a></li><li class="footer-moz-item"><a href="https://www.mozilla.org/about/governance/policies/participation/" class="footer-moz-link" target="_blank" rel="noopener noreferrer">Community Participation Guidelines</a></li></ul></div><div class="page-footer-legal"><p id="license" class="page-footer-legal-text">Visit <a href="https://www.mozilla.org" target="_blank" rel="noopener noreferrer">Mozilla Corporation’s</a> not-for-profit parent, the <a target="_blank" rel="noopener noreferrer" href="https://foundation.mozilla.org/">Mozilla Foundation</a>.<br/>Portions of this content are ©1998–2025 by individual mozilla.org contributors. Content available under <a href="/ja/docs/MDN/Writing_guidelines/Attrib_copyright_license">a Creative Commons license</a>.</p></div></div></footer></div><script type="application/json" id="hydration">{"url":"/ja/docs/MDN/Writing_guidelines/Howto/Write_an_api_reference","doc":{"body":[{"type":"prose","value":{"id":null,"title":null,"isH3":false,"content":"<p>このガイドでは、 MDN で API リファレンスを書くために必要なすべてのことを説明します。</p>"}},{"type":"prose","value":{"id":"準備","title":"準備","isH3":false,"content":"<p>API の記事を書き始める前に、実際に書き始める前に準備・計画しておくべきことがいくつかあります。</p>"}},{"type":"prose","value":{"id":"前提知識","title":"前提知識","isH3":true,"content":"<p>このガイドを読む前に、相応の知識を持っていることを前提としています。</p>\n<ul>\n<li>HTML、CSS、JavaScript などのウェブ技術。特に JavaScript は重要です。</li>\n<li>ウェブ技術の仕様書の読み方。 API を文書化する際に、これらの仕様書をよく見ることになるでしょう。</li>\n</ul>\n<p>それ以外のことは、その過程で学ぶことができます。</p>"}},{"type":"prose","value":{"id":"前提条件となるリソース","title":"前提条件となるリソース","isH3":true,"content":"<p>API の文書化を始める前に、利用可能なものを用意しておく必要があります。</p>\n<ol>\n<li>\n<p>最新の仕様書:\nW3C 勧告であれ、初期の編集者草案であれ、その機能をカバーする（またはカバーすることを指定する）仕様書の利用可能な最新の草案を参照する必要があります。それを見つけるには、通常、ウェブ検索を行います。最新版は、多くの場合、その仕様書のすべての版からリンクされており、 \"latest draft\" などとリストアップされているはずです。</p>\n</li>\n<li>\n<p>最新のウェブブラウザー:\nこれらは、 <a href=\"https://www.mozilla.org/ja/firefox/channel/desktop/\" class=\"external\" target=\"_blank\">Firefox Nightly</a>/<a href=\"https://www.google.com/intl/en/chrome/canary/\" class=\"external\" target=\"_blank\">Chrome Canary</a> などの実験的/アルファビルドであるべきで、文書化しようとしている機能に対応している可能性がより高いものです。\nこれは、特に新しい/実験的な機能を文書化する場合に適切です。</p>\n</li>\n<li>\n<p>デモ/ブログ記事/その他の情報: できるだけ多くの情報を見つけてください。</p>\n</li>\n<li>\n<p>有用な技術連絡先:\n仕様について質問できる親切な技術者、 API の標準化やブラウザーへの実装に携わっている人を見つけると本当に有益です。\nそのような人を探すのに良い場所には下記のものがあります。</p>\n<ul>\n<li>あなたが関連企業に勤めている場合、社内アドレス帳。</li>\n<li>その API の議論に関与している公開メーリングリスト。例えば Mozilla の <a href=\"https://groups.google.com/a/mozilla.org/g/dev-platform/\" class=\"external\" target=\"_blank\">dev-platform</a> リストや W3C の <a href=\"https://lists.w3.org/Archives/Public/public-webapps/\" class=\"external\" target=\"_blank\">public-webapps</a> リストなど。</li>\n<li>仕様書そのもの。例えば、 <a href=\"https://webaudio.github.io/web-audio-api/\" class=\"external\" target=\"_blank\">Web Audio API 仕様書</a>には、冒頭に作者とその連絡先が記載されています。</li>\n</ul>\n</li>\n</ol>"}},{"type":"prose","value":{"id":"時間をかけて_api_を使ってみる","title":"時間をかけて API を使ってみる","isH3":true,"content":"<p>API を文書化する過程で、何度もデモを作ることになるでしょう。しかし、 API がどのように動作するかに慣れることから始めるのが有効です。主なインターフェイス、プロパティ、メソッドは何か、主な用途は何か、そしてそれを使って簡単な機能を書く方法を学びましょう。</p>\n<p>API が変更された場合、参考にしたり学んだりする既存のデモが古くなっていないか注意する必要があります。デモで使われている主な構成要素が、最新の仕様と一致しているかどうかを確認してください。また、最新のブラウザーでは動作しないかもしれませんが、後方互換性のために古い機能に対応し続けていることが多いので、これはあまり信頼できるテストではありません。</p>\n<div class=\"notecard note\">\n<p><strong>メモ:</strong>\n最近仕様が更新され。例えばあるメソッドの定義が変わったが、古いメソッドがまだブラウザーで動作する場合、古いメソッドと新しいメソッドをカバーするために、同じ場所で両方の記事を作成しなければならないことがよくあります。\n困ったときは、見つけたデモを参考にしたり、担当のエンジニアに聞いたりしてください。</p>\n</div>"}},{"type":"prose","value":{"id":"執筆や更新が必要な記事のリストを作成する","title":"執筆や更新が必要な記事のリストを作成する","isH3":true,"content":"<p>API リファレンスには、一般的に次のようなページが含まれます。\n各ページの内容。例、テンプレートの詳細は、<a href=\"/ja/docs/MDN/Writing_guidelines/Page_structures/Page_types\">ページの種類</a>の記事で確認することができます。\n作業を始める前に、作成すべきすべてのページのリストを書き出してください。</p>\n<ol>\n<li>概要ページ</li>\n<li>インターフェイスページ</li>\n<li>コンストラクターページ</li>\n<li>メソッドページ</li>\n<li>プロパティページ</li>\n<li>イベントページ</li>\n<li>概念/ガイドページ</li>\n<li>例</li>\n</ol>\n<div class=\"notecard note\">\n<p><strong>メモ:</strong>\nこの記事では。例として<a href=\"/ja/docs/Web/API/Web_Audio_API\">ウェブオーディオ API</a>を参照します。</p>\n</div>\n<h4 id=\"概要ページ\">概要ページ</h4>\n<p>API の概要ページは、 API の役割、最上位のインターフェイス、他のインターフェイスに含まれる関連機能、その他の高水準な詳細を説明するために使われます。\n名前とスラッグは API の名前と最後に \"API\" を付けたものとしてください。 API リファレンスの最上位に置かれ、<a href=\"/ja/docs/Web/API\">https://developer.mozilla.org/ja/docs/Web/API</a>の子として扱われます。</p>\n<p>例:</p>\n<ul>\n<li>Title: <em>ウェブオーディオ API</em></li>\n<li>Slug: <em>Web_Audio_API</em></li>\n<li>URL: <a href=\"/ja/docs/Web/API/Web_Audio_API\">https://developer.mozilla.org/ja/docs/Web/API/Web_Audio_API</a></li>\n</ul>\n<h4 id=\"インターフェイスページ\">インターフェイスページ</h4>\n<p>各インターフェイスは、インターフェイスの目的を説明し、メンバー（コンストラクター、メソッド、プロパティなど）をリストアップし、どのブラウザーと互換性があるかを示す、独自のページがあります。\nページの名前とスラッグは、仕様書に書かれているとおりのインターフェイスの名前でなければなりません。\n各ページは、 API リファレンスの最上位に、 <a href=\"/ja/docs/Web/API\">https://developer.mozilla.org/ja/docs/Web/API</a> の子として配置されます。</p>\n<p>例:</p>\n<ul>\n<li>Title: <em>AudioContext</em></li>\n<li>Slug: <em>AudioContext</em></li>\n<li>URL: <a href=\"/ja/docs/Web/API/AudioContext\">https://developer.mozilla.org/ja/docs/Web/API/AudioContext</a></li>\n</ul>\n\u003c!-- -->\n<ul>\n<li>Title: <em>AudioNode</em></li>\n<li>Slug: <em>AudioNode</em></li>\n<li>URL: <a href=\"/ja/docs/Web/API/AudioNode\">https://developer.mozilla.org/ja/docs/Web/API/AudioNode</a></li>\n</ul>\n<div class=\"notecard note\">\n<p><strong>メモ:</strong>\nインターフェイスに登場するメンバーはすべて文書化します。以下のルールに留意してください。</p>\n</div>\n<ul>\n<li>このインターフェイスを実装したオブジェクトのプロトタイプ上で定義されているメソッド（インスタンスメソッド）と、実際のクラス自身で定義されるメソッド（静的メソッド）を文書化します。\nまれに同じインターフェイスに両方が存在する場合は、ページ内で別々の節に（静的メソッド／インスタンスメソッドとして）記載します。\n通常はインスタンスメソッドしか存在しないので、その場合は「メソッド」というタイトルで記載します。</li>\n<li>継承されたプロパティやメソッドは、それぞれの親インターフェイスに掲載されているので文書化しません。しかし、その存在を示唆することはあります。</li>\n<li>ミックスインで定義されたプロパティやメソッドの記事を作成します。詳しくは<a href=\"/ja/docs/MDN/Writing_guidelines/Howto/Write_an_api_reference/Information_contained_in_a_WebIDL_file#mixin\">ミックスインの協力ガイド</a>を参照してください。</li>\n<li>文字列化 (<code>toString()</code>) や JSON 化 (<code>toJSON()</code>) のような特殊なメソッドも、存在する場合は掲載します。</li>\n<li>名前の付いたコンストラクター（<a href=\"/ja/docs/Web/API/HTMLImageElement\"><code>HTMLImageElement</code></a> における <code>Image()</code> など）も、関連があれば掲載します。</li>\n</ul>\n<h4 id=\"コンストラクターページ\">コンストラクターページ</h4>\n<p>各インターフェイスには 0 個または 1 個のコンストラクターがあり、インターフェイスのページのサブページで文書化されています。コンストラクターの目的を説明し、その構文がどのようなものか、使用例、ブラウザーの互換性情報などを表示します。スラッグはコンストラクターの名前で、インターフェイス名と全く同じです。タイトルはインターフェイス名、ドット、コンストラクター名、そして最後に括弧を置きます。</p>\n<p>例:</p>\n<ul>\n<li>Title: <em>AudioContext.AudioContext()</em></li>\n<li>Slug: <em>AudioContext</em></li>\n<li>URL: <a href=\"/ja/docs/Web/API/AudioContext/AudioContext\">https://developer.mozilla.org/ja/docs/Web/API/AudioContext/AudioContext</a></li>\n</ul>\n<h4 id=\"プロパティページ\">プロパティページ</h4>\n<p>各インターフェイスには 0 個以上のプロパティがあり、インターフェイスのページのサブページで説明されています。各ページでは、そのプロパティの目的、構文の様子、使用例、ブラウザーの互換性情報などが説明されています。スラッグはプロパティの名前であり、タイトルはインターフェイス名、ドット、プロパティ名の順になります。</p>\n<p>例:</p>\n<ul>\n<li>Title: <em>AudioContext.state</em></li>\n<li>Slug: <em>state</em></li>\n<li>URL: <a href=\"/ja/docs/Web/API/BaseAudioContext/state\">https://developer.mozilla.org/ja/docs/Web/API/AudioContext/state</a></li>\n</ul>\n\u003c!-- -->\n<h4 id=\"メソッドページ\">メソッドページ</h4>\n<p>各インターフェイスには 0 個以上のメソッドがあり、インターフェイスのページのサブページで文書化されています。各ページでは、メソッドの目的を説明し、その構文がどのようなものか、使用例、ブラウザーの互換性情報などを示しています。スラッグはメソッドの名前であり、タイトルはインターフェイス名、ドット、メソッド名、括弧の順です。</p>\n<p>例:</p>\n<ul>\n<li>Title: <em>AudioContext.close()</em></li>\n<li>Slug: <em>close</em></li>\n<li>URL: <a href=\"/ja/docs/Web/API/AudioContext/close\">https://developer.mozilla.org/ja/docs/Web/API/AudioContext/close</a></li>\n</ul>\n\u003c!-- -->\n<ul>\n<li>Title: <em>AudioContext.createGain()</em></li>\n<li>Slug: <em>createGain</em></li>\n<li>URL: <a href=\"/ja/docs/Web/API/BaseAudioContext/createGain\">https://developer.mozilla.org/ja/docs/Web/API/AudioContext/createGain</a></li>\n</ul>\n<h4 id=\"イベントページ\">イベントページ</h4>\n<p>イベントはターゲットのインターフェイスのサブページとして文書化し、スラッグは <em>イベント名</em>_event、タイトルは <code>インターフェイス: eventName イベント</code> としてください。</p>\n<p><code>on</code> イベントハンドラープロパティのページを作成しないでください。 <code>eventName_イベント</code> のページで、イベントにアクセスする両方の方法について説明してください。</p>\n<p>例:</p>\n<ul>\n<li>Title: XRSession: end イベント</li>\n<li>Slug: end_event</li>\n<li>URL: <a href=\"/en-US/docs/Web/API/XRSession/end_event\" class=\"only-in-en-us\">https://developer.mozilla.org/ja/docs/Web/XRSession/end_event</a></li>\n</ul>\n<h4 id=\"概念ガイドページ\">概念/ガイドページ</h4>\n<p>ほとんどの API リファレンスには少なくとも 1 つのガイドがあり、時にはそれに付随する概念ページもあります。最低でも API リファレンスには「<em>API 名</em> の使用」というガイドがあるべきで、これは API の使い方の基本的なガイドを提供するものです。より複雑な API では、 API の異なる側面の使い方を説明するために、複数の使用法ガイドが必要になるかもしれません。</p>\n<p>必要であれば、「<em>API 名</em> の概念」という概念記事も含めることができます。この記事では、 API を効果的に使うために開発者が理解しておくべき、 API に関連する概念の背後にある理論を説明します。</p>\n<p>これらの記事はすべて、 API 概要ページのサブページとして作成する必要があります。例えば、ウェブオーディオには 4 つのガイドと 1 つの概念の記事があります。</p>\n<ul>\n<li><a href=\"/ja/docs/Web/API/Web_Audio_API/Using_Web_Audio_API\">https://developer.mozilla.org/ja/docs/Web/API/Web_Audio_API/Using_Web_Audio_API</a></li>\n<li><a href=\"/ja/docs/Web/API/Web_Audio_API/Visualizations_with_Web_Audio_API\">https://developer.mozilla.org/ja/docs/Web/API/Web_Audio_API/Visualizations_with_Web_Audio_API</a></li>\n<li><a href=\"/ja/docs/Web/API/Web_Audio_API/Web_audio_spatialization_basics\">https://developer.mozilla.org/ja/docs/Web/API/Web_Audio_API/Web_audio_spatialization_basics</a></li>\n<li><a href=\"/ja/docs/Web/API/Web_Audio_API/Basic_concepts_behind_Web_Audio_API\">https://developer.mozilla.org/ja/docs/Web/API/Web_Audio_API/Basic_concepts_behind_Web_Audio_API</a></li>\n</ul>\n<h4 id=\"例\">例</h4>\n<p>少なくとも、 API の最も一般的な使用例を示すいくつかの例を作成する必要があります。これらは適切な場所に置くことができますが、推奨される場所は <a href=\"https://github.com/mdn/\" class=\"external\" target=\"_blank\">MDN の GitHub リポジトリー</a>です。</p>\n<h4 id=\"全体の一覧の作成\">全体の一覧の作成</h4>\n<p>これらのサブページの一覧を作成すると、追跡するために便利です。例えば次のようにします。</p>\n<ul>\n<li>\n<p>Web_Audio_API</p>\n</li>\n<li>\n<p>AudioContext</p>\n<ul>\n<li>AudioContext.currentTime</li>\n<li>AudioContext.destination</li>\n<li>AudioContext.listener</li>\n<li>…</li>\n<li>AudioContext.createBuffer()</li>\n<li>AudioContext.createBufferSource()</li>\n<li>…</li>\n</ul>\n</li>\n<li>\n<p>AudioNode</p>\n<ul>\n<li>AudioNode.context</li>\n<li>AudioNode.numberOfInputs</li>\n<li>AudioNode.numberOfOutputs</li>\n<li>…</li>\n<li>AudioNode.connect(Param)</li>\n<li>…</li>\n</ul>\n</li>\n<li>\n<p>AudioParam</p>\n</li>\n<li>\n<p>Events (update list)</p>\n<ul>\n<li>start</li>\n<li>end</li>\n<li>…</li>\n</ul>\n</li>\n</ul>\n<p>リストの各インターフェイスは、 <code>https://developer.mozilla.org/ja/docs/Web/API</code> のサブページとして独立したページが作成されています。例えば、 <a href=\"/ja/docs/Web/API/AudioContext\"><code>AudioContext</code></a> の記事は、<code>https://developer.mozilla.org/ja/docs/Web/API/AudioContext</code> の場所にあります。各<a href=\"#インターフェイスページ\">インターフェイスページ</a>では、そのインターフェイスが何をするのかを説明し、そのインターフェイスを構成するメソッドとプロパティのリストを提供しています。そして、各メソッドとプロパティは、それがメンバーであるインターフェイスのサブページとして作成され、それ自身のページで文書化されます。例えば、 <a href=\"/ja/docs/Web/API/BaseAudioContext/currentTime\"><code>BaseAudioContext/currentTime</code></a> は、 <code>https://developer.mozilla.org/ja/docs/Web/API/AudioContext/currentTime</code> で文書化されています。</p>"}},{"type":"prose","value":{"id":"ページの作成","title":"ページの作成","isH3":false,"content":"<p>次に、以下の構造に従って必要なページを作成します。 <a href=\"https://github.com/mdn/content#adding-a-new-document\" class=\"external\" target=\"_blank\">MDN の content の README</a> には、新しい記事を作成する手順が書かれています。また、<a href=\"/ja/docs/MDN/Writing_guidelines/Page_structures/Page_types\">ページの種類</a>のガイドには、役に立つかもしれない例やページテンプレートが書かれています。</p>"}},{"type":"prose","value":{"id":"概要ページの構成","title":"概要ページの構成","isH3":true,"content":"<p>API ランディングページは、 API の規模によって長さが大きく異なりますが、基本的にはどれも同じような機能を備えています。長いランディングページの例としては <a href=\"/ja/docs/Web/API/Web_Audio_API\">https://developer.mozilla.org/ja/docs/Web/API/Web_Audio_API</a> を参照してください。</p>\n<p>ランディングページの特徴は、以下の通りです。</p>\n<ol>\n<li><strong>説明</strong>: ランディングページの最初の段落では、 API の包括的な目的を短く簡潔に説明する必要があります。</li>\n<li><strong>概要と用途の節</strong>: 次の節は、 \"[name of API] concepts and usage\" と題し、 API が提供する主な機能、解決する問題、動作方法などの概要を、高い水準で説明する必要があります。この節はかなり短くし、コードや特定の実装の詳細には触れないようにしてください。</li>\n<li><strong>インターフェイスの一覧</strong>: この節は、「[API 名] のインターフェイス」というタイトルで、 API を構成する各インターフェイスのリファレンスページへのリンクと、各インターフェイスの機能についての簡単な説明を提供します。新しいページを素早く作成する方法については、「{{domxref}} マクロを使用した他の API 機能の参照」を参照してください。</li>\n<li><strong>例</strong>: この節では、 API の簡単な使用例を 1 つか 2 つ示してください。</li>\n<li><strong>仕様書一覧表</strong>: ここに、仕様書の一覧表を入れる必要があります。詳しくは「仕様書参照表の作成」の節をご覧ください。</li>\n<li><strong>ブラウザーの互換性</strong>: ここに、ブラウザーの互換性一覧表を入れてください。詳しくは<a href=\"/ja/docs/MDN/Writing_guidelines/Page_structures/Compatibility_tables\">互換性一覧表</a>をご覧ください。</li>\n<li><strong>関連情報</strong>: 「関連情報」の節には、 MDN （および外部）のチュートリアル、サンプル、ライブラリーなど、この技術について学ぶ際に役立つかもしれないさらなるリンクを含める野に良い場所です。</li>\n<li><strong>タグ</strong>: 各リファレンスページに含めるべき標準タグがあります。詳しくは「タグ」の節をご覧ください。</li>\n</ol>"}},{"type":"prose","value":{"id":"インターフェイスページの構成","title":"インターフェイスページの構成","isH3":true,"content":"<p>これで、インターフェイスのページを書き始める準備が整ったはずです。各インターフェイスリファレンスページは、以下の構造を守る必要があります。</p>\n<ol>\n<li>\n<p><strong>{{APIRef}}</strong>: 各インターフェイスページの最初の行に {{APIRef}} マクロを置き、引数に API の名前を入れてください。例えば {{APIRef(\"Web Audio API\")}} のようにします。このマクロは、インターフェイスページの左側にリファレンスメニューを作成します。このマクロはインターフェイスページの左側のリファレンスメニューを構築します。そこにはプロパティやメソッド、および <a href=\"https://github.com/mdn/content/blob/main/files/jsondata/GroupData.json\" class=\"external\" target=\"_blank\">GroupData</a> マクロで定義されたその他のクイックリンクを含みます（既存の GroupData 項目に API を追加するか、まだリストにない場合は新しい項目を作成するよう誰かに依頼してください）。メニューは、以下のスクリーンショットのようなものになります。\n<img src=\"/ja/docs/MDN/Writing_guidelines/Howto/Write_an_api_reference/apiref-links.png\" alt=\"このスクリーンショットは、 APIRef マクロによって生成された、メソッドとプロパティの複数のサブリストを持つ OscillatorNode インターフェイスの垂直ナビゲーションメニューを示します。\" width=\"302\" height=\"384\" loading=\"lazy\"></p>\n</li>\n<li>\n<p><strong>機能状態</strong>: <a href=\"/ja/docs/MDN/Writing_guidelines/Page_structures/Feature_status#feature_status_page_banners\">機能状態を示すバナー</a> （非推奨、標準外、実験的）が必要に応じて自動的に追加されます。そのために必要なことは、 <a href=\"/ja/docs/MDN/Writing_guidelines/Page_structures/Feature_status#how_to_add_or_update_feature_statuses\">browser-compat-data リポジトリーの状態を更新</a>することです。</p>\n</li>\n<li>\n<p><strong>説明</strong>: インターフェイスページの最初の段落では、インターフェイスの包括的な目的を簡潔に説明する必要があります。追加の説明が必要な場合は、さらに数段落を含めるとよいでしょう。インターフェイスが実質的には辞書である場合、「インターフェイス」の代わりにその用語を使用する必要があります。</p>\n</li>\n<li>\n<p><strong>継承図:</strong> <a href=\"https://github.com/mdn/yari/blob/main/kumascript/macros/InheritanceDiagram.ejs\" class=\"external\" target=\"_blank\"><code>{{InheritanceDiagram}}</code></a> マクロを使用して、このインターフェイスの SVG の継承図を埋め込みます。</p>\n</li>\n<li>\n<p><strong>プロパティの一覧、メソッドの一覧</strong>: これらの節は、「プロパティ」と「メソッド」というタイトルで、そのインターフェイスのそれぞれのプロパティ/メソッドのリファレンスページへのリンクと（{{domxref}} マクロを使用します）、それぞれのプロパティが何を行うかの説明を提供します。これらは<a href=\"/ja/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN#定義リスト\">説明/定義リスト</a>を使用してマークアップしてください。それぞれの説明は短く簡潔にしてください。可能であれば 1 文で。他のページへのリンクを素早く作成する方法については、「{{domxref}} マクロによる他の API 機能の参照」を参照してください。</p>\n<p>それぞれの節の冒頭で、プロパティ/メソッドの一覧の前に、イタリック体で適切な文章を使用して継承を示してください。</p>\n<ul>\n<li><em>このインターフェイスは固有のプロパティを実装していませんが、 {{domxref(\"XYZ\")}}, および {{domxref(\"XYZ2\")}} からプロパティを継承しています。</em></li>\n<li><em>このインターフェイスには {{domxref(\"XYZ\")}}, および {{domxref(\"XYZ2\")}} から継承したプロパティもあります。</em></li>\n<li><em>このインターフェイスは固有のメソッドを実装していませんが、 {{domxref(\"XYZ\")}}, および {{domxref(\"XYZ2\")}} からメソッドを継承しています。</em></li>\n<li><em>このインターフェイスには {{domxref(\"XYZ\")}}, および {{domxref(\"XYZ2\")}} から継承したプロパティもあります。</em></li>\n</ul>\n<div class=\"notecard note\">\n<p><strong>メモ:</strong>\n読み取り専用のプロパティには {{ReadOnlyInline}} マクロを、その {{domxref}} リンクと同じ行に設置すると、小さくてかっこいい「読み取り専用」バッジを生成します。（必要に応じて、{{experimentalInline}}, {{non-standard_Inline}}, {{deprecatedInline}} マクロの後に使用してください）。</p>\n</div>\n</li>\n<li>\n<p><strong>例</strong>: API の主要な機能の典型的な使用法を示すコードリストを入れてください。すべてのコードを列挙するのではなく、そのうちの興味深い部分のみを並べてください。完全なコードのリストを紹介する場合は。例の全体を含んだ <a href=\"https://github.com/\" class=\"external\" target=\"_blank\">GitHub</a> リポジトリーを参照することができます。また、 <a href=\"https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site\" class=\"external\" target=\"_blank\">GitHub gh-pages</a> の機能を使って作成したライブサンプルにリンクすることもできます（もちろん、クライアント側のコードしか使用していなければですが）。サンプルが視覚的であれば、MDN <a href=\"/ja/docs/MDN/Writing_guidelines/Page_structures/Live_samples\">ライブサンプル</a> 機能を使ってページ内でライブ実行できるようにすることができます。</p>\n</li>\n<li>\n<p><strong>仕様書一覧表</strong>: ここに、仕様書一覧表を入れる必要があります。詳しくは「仕様書参照表の作成」の節をご覧ください。</p>\n</li>\n<li>\n<p><strong>ブラウザーの互換性</strong>: ここで、ブラウザーの互換性一覧表を入れる必要があります。詳しくは、<a href=\"/ja/docs/MDN/Writing_guidelines/Page_structures/Compatibility_tables\">互換性一覧表</a>を参照してください。</p>\n</li>\n<li>\n<p><strong>ポリフィル</strong>: 適切であれば、この節に、 API を実装していないブラウザーでも使用できるようにするためのポリフィルのコードを提供してください。ポリフィルが存在しない、あるいは必要ない場合は、この節は完全に除外してください。</p>\n</li>\n<li>\n<p><strong>関連情報</strong>: 「関連情報」の節は、 MDN （および外部）のチュートリアル、サンプル、ライブラリーなど、この技術について学ぶときに役立つかもしれないさらなるリンクを置くのに良い場所です。私たちは外部ソースへのリンクに対して自由なポリシーを持っていますが、注意してください。</p>\n<ul>\n<li>MDN の他のページと同じ情報を持つページを加えないでください。代わりにそのページにリンクしてください。</li>\n<li>著者名を記載しないでください - 私たちは作家中立のドキュメントサイトです。ドキュメントにリンクすれば、そこに著者名が表示されます。</li>\n<li>ブログの記事は特に注意が必要です。古くなりがちだからですです（古い構文、間違った互換性情報）。メンテナンスされた文書にはない明確な付加価値がある場合のみ、リンクを張ってください。</li>\n<li>「詳しくは ... を参照してください」や「... をクリックしてください」のような動作動詞は使わないでください。読者が見ることができるかどうか、リンクをクリックできるかどうか（紙版のドキュメントのように）分からないからです。</li>\n</ul>\n</li>\n</ol>\n<h4 id=\"インターフェイスのページの例\">インターフェイスのページの例</h4>\n<p>インターフェイスページの代表的な例を以下に示します。</p>\n<ul>\n<li><a href=\"/ja/docs/Web/API/Request\"><code>Request</code></a> （<a href=\"/ja/docs/Web/API/Fetch_API\">フェッチ API</a>）</li>\n<li><a href=\"/ja/docs/Web/API/SpeechSynthesis\"><code>SpeechSynthesis</code></a> （<a href=\"/ja/docs/Web/API/Web_Speech_API\">ウェブ音声 API</a>）</li>\n</ul>"}},{"type":"prose","value":{"id":"プロパティページの構成","title":"プロパティページの構成","isH3":true,"content":"<p>プロパティページは、それらが実装されているインターフェイスのサブページとして作成してください。他のプロパティページの構造をコピーして、新しいページの基礎とします。</p>\n<p>プロパティページの名前は <code>インターフェイス.プロパティ名</code> という規則に従うように編集してください。</p>\n<p>プロパティページには以下の節が必要です。</p>\n<ol>\n<li>\n<p><strong>タイトル</strong>: ページのタイトルは、<strong>インターフェイス名.プロパティ名</strong> とする必要があります。インターフェイス名は大文字で始めなければなりません。 JavaScript ではインターフェイスはオブジェクトのプロトタイプに実装されますが、 <a href=\"/ja/docs/Web/JavaScript/Reference\">JavaScript リファレンス</a>のようにタイトルに <code>.prototype.</code> を含めることはありません。</p>\n</li>\n<li>\n<p><strong>{{APIRef}}</strong>: 各プロパティページの最初の行に {{APIRef}} マクロを置き、引数に API の名前を入れてください。例えば {{APIRef(\"Web Audio API\")}} のようにします。このマクロは、プロパティページの左側にリファレンスメニューを作成します。このマクロはプロパティページの左側のリファレンスメニューを構築します。そこにはプロパティやメソッド、および <a href=\"https://github.com/mdn/content/blob/main/files/jsondata/GroupData.json\" class=\"external\" target=\"_blank\">GroupData</a> マクロで定義されたその他のクイックリンクを含みます（既存の GroupData 項目に API を追加するか、まだリストにない場合は新しい項目を作成するよう誰かに依頼してください）。メニューは、以下のスクリーンショットのようなものになります。\n<img src=\"/ja/docs/MDN/Writing_guidelines/Howto/Write_an_api_reference/apiref-links.png\" alt=\"このスクリーンショットは、 APIRef マクロによって生成された、メソッドとプロパティの複数のサブリストを持つ OscillatorNode インターフェイスの垂直ナビゲーションメニューを示します。\" width=\"302\" height=\"384\" loading=\"lazy\"></p>\n</li>\n<li>\n<p><strong>機能状態</strong>: <a href=\"/ja/docs/MDN/Writing_guidelines/Page_structures/Feature_status#feature_status_page_banners\">機能状態を示すバナー</a> （非推奨、標準外、実験的）が必要に応じて自動的に追加されます。そのために必要なことは、 <a href=\"/ja/docs/MDN/Writing_guidelines/Page_structures/Feature_status#how_to_add_or_update_feature_statuses\">browser-compat-data リポジトリーの状態を更新</a>することです。</p>\n</li>\n<li>\n<p><strong>説明</strong>: プロパティページの最初の段落には、そのプロパティの包括的な目的を短く簡潔に説明する必要があります。また、追加の説明が必要な場合は、さらにいくつかの段落を書くととよいでしょう。明らかに記述すべき追加情報は、その既定値/初期値、および読み取り専用かどうかです。最初の文の構成は、次のようにしなければなりません。</p>\n<dl>\n<dt id=\"読み取り専用のプロパティの場合\"><a href=\"#読み取り専用のプロパティの場合\">読み取り専用のプロパティの場合</a></dt>\n<dd>\n<p><strong><code>インターフェイス名.プロパティ</code></strong> は読み取り専用のプロパティで、 {{domxref(\"type\")}} を返します…</p>\n</dd>\n<dt id=\"その他のプロパティの場合\"><a href=\"#その他のプロパティの場合\">その他のプロパティの場合</a></dt>\n<dd>\n<p><strong><code>インターフェイス名.プロパティ</code></strong> プロパティは {{domxref(\"type\")}} 型で…</p>\n</dd>\n</dl>\n<div class=\"notecard note\">\n<p><strong>メモ:</strong> <code>インターフェイス名.プロパティ</code> は <code><code></code> の中に入れ、最初に使用される場合は太字 (<code><strong></code>) で記述してください。</p>\n</div>\n</li>\n<li>\n<p><strong>値</strong>: 値の節では、プロパティの値の説明を行います。これにはプロパティのデータ型と、それが何を表しているかを説明する必要があります。例として、 <a href=\"/ja/docs/Web/API/SpeechRecognition/grammars\"><code>SpeechRecognition.grammars</code></a> を参照してください。</p>\n</li>\n<li>\n<p><strong>例</strong>: プロパティの典型的な使用方法を示すために、コードのリストを含めてください。その型のオブジェクトがどのように作成され、どのようにプロパティにアクセスするかを示す簡単な例から始める必要があります。より複雑な例は、そのような例の後に追加することができます。すべてのコードを列挙するのではなく、そのうちの興味深い部分のみを並べてください。完全なコードのリストを紹介する場合は。例の全体を含んだ <a href=\"https://github.com/\" class=\"external\" target=\"_blank\">GitHub</a> リポジトリーを参照することができます。また、 <a href=\"https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site\" class=\"external\" target=\"_blank\">GitHub gh-pages</a> の機能を使って作成したライブサンプルにリンクすることもできます（もちろん、クライアント側のコードしか使用していなければですが）。サンプルが視覚的であれば、MDN <a href=\"/ja/docs/MDN/Writing_guidelines/Page_structures/Live_samples\">ライブサンプル</a> 機能を使ってページ内でライブ実行できるようにすることができます。</p>\n</li>\n<li>\n<p><strong>仕様書一覧表</strong>: ここに、仕様書一覧表を入れる必要があります。詳しくは「仕様書参照表の作成」の節をご覧ください。</p>\n</li>\n<li>\n<p><strong>ブラウザーの互換性</strong>: ここで、ブラウザーの互換性一覧表を入れる必要があります。詳しくは、<a href=\"/ja/docs/MDN/Writing_guidelines/Page_structures/Compatibility_tables\">互換性一覧表</a>を参照してください。</p>\n</li>\n<li>\n<p><strong>関連情報</strong>: 「関連情報」の節は、この技術を使用する際に役立つかもしれないさらなるリンクを置くのに良い場所です。このプロパティの変更によって影響を受けるメソッドやプロパティ、またはそれに関連して発行されるイベントなどです。 MDN （および外部）のチュートリアル、サンプル、ライブラリーなど、この技術について学ぶ際に役立つリンクを追加することができますが、代わりにインターフェイスのリファレンスページに追加することを考慮すると便利かもしれません。</p>\n</li>\n</ol>\n<h4 id=\"プロパティページの例\">プロパティページの例</h4>\n<p>以下に、プロパティページの例を示します。</p>\n<ul>\n<li><a href=\"/ja/docs/Web/API/Request/method\"><code>Request.method</code></a> （<a href=\"/ja/docs/Web/API/Fetch_API\">フェッチ API</a>）</li>\n<li><a href=\"/en-US/docs/Web/API/SpeechSynthesis/speaking\" class=\"only-in-en-us\"><code>SpeechSynthesis.speaking</code></a> （<a href=\"/ja/docs/Web/API/Web_Speech_API\">ウェブ音声 API</a>）</li>\n</ul>"}},{"type":"prose","value":{"id":"メソッドページの構成","title":"メソッドページの構成","isH3":true,"content":"<p>メソッドページは、実装されるインターフェイスのサブページとして作成してくあさい。他のメソッドページの構造をコピーして、新しいページの基礎とします。</p>\n<p>メソッドページには以下の節が必要です。</p>\n<ol>\n<li>\n<p><strong>タイトル</strong>: ページのタイトルは、<strong>インターフェイス名.メソッド名()</strong> （最後に 2 つの括弧つき）とする必要がありますが、スラッグ（ページ URL の最後）は括弧をつけてはいけません。また、インターフェイス名は大文字で始めなければなりません。 JavaScript ではインターフェイスはオブジェクトのプロトタイプに実装されますが、 <a href=\"/ja/docs/Web/JavaScript/Reference\">JavaScript リファレンス</a>のようにタイトルに <code>.prototype.</code> を含めることはありません。</p>\n</li>\n<li>\n<p><strong>{{APIRef}}</strong>: 各メソッドページの最初の行に {{APIRef}} マクロを置き、引数に API の名前を入れてください。例えば {{APIRef(\"Web Audio API\")}} のようにします。このマクロは、メソッドページの左側にリファレンスメニューを作成します。このマクロはインターフェイスページの左側のリファレンスメニューを構築します。そこにはプロパティやメソッド、および <a href=\"https://github.com/mdn/content/blob/main/files/jsondata/GroupData.json\" class=\"external\" target=\"_blank\">GroupData</a> マクロで定義されたその他のクイックリンクを含みます（既存の GroupData 項目に API を追加するか、まだリストにない場合は新しい項目を作成するよう誰かに依頼してください）。メニューは、以下のスクリーンショットのようなものになります。\n<img src=\"/ja/docs/MDN/Writing_guidelines/Howto/Write_an_api_reference/apiref-links.png\" alt=\"このスクリーンショットは、 APIRef マクロによって生成された、メソッドとプロパティの複数のサブリストを持つ OscillatorNode インターフェイスの垂直ナビゲーションメニューを示します。\" width=\"302\" height=\"384\" loading=\"lazy\"></p>\n</li>\n<li>\n<p><strong>機能状態</strong>: <a href=\"/ja/docs/MDN/Writing_guidelines/Page_structures/Feature_status#feature_status_page_banners\">機能状態を示すバナー</a> （非推奨、標準外、実験的）が必要に応じて自動的に追加されます。そのために必要なことは、 <a href=\"/ja/docs/MDN/Writing_guidelines/Page_structures/Feature_status#how_to_add_or_update_feature_statuses\">browser-compat-data リポジトリーの状態を更新</a>することです。</p>\n</li>\n<li>\n<p><strong>説明</strong>: メソッドページの最初の段落には、そのメソッドの包括的な目的を短く簡潔に説明する必要があります。また、追加の説明が必要な場合は、さらにいくつかの段落を書くととよいでしょう。明らかに追加すべき情報は、デフォルト引数の値、そのメソッドが依存する理論、および引数値が行うことです。</p>\n<dl>\n<dt id=\"最初の文の冒頭は、次のような構成にしなければなりません。\"><a href=\"#最初の文の冒頭は、次のような構成にしなければなりません。\">最初の文の冒頭は、次のような構成にしなければなりません。</a></dt>\n<dd>\n<p><strong><code>インターフェイス名.メソッド名()</code></strong> メソッドインターフェイスは…</p>\n</dd>\n</dl>\n<div class=\"notecard note\">\n<p><strong>メモ:</strong> <code>インターフェイス名.メソッド名()</code> は <code><code></code> の中に入れ、最初に使用される場合は太字 (<code><strong></code>) で記述してください。</p>\n</div>\n</li>\n<li>\n<p><strong>構文</strong>: 構文の節には、 2 - 3 行の例（通常はインターフェイスの構築とインターフェイスメソッドの呼び出しのみ）を含める必要があります。</p>\n<dl>\n<dt id=\"構文は次の形式にしてください。\"><a href=\"#構文は次の形式にしてください。\">構文は次の形式にしてください。</a></dt>\n<dd>\n<p>method(param1, param2, …)</p>\n</dd>\n</dl>\n<p>構文の節には、以下の 3 つの項を入れてください（例として、 <a href=\"/ja/docs/Web/API/SubtleCrypto/sign\"><code>SubtleCrypto.sign()</code></a> を参照してください）。</p>\n<ul>\n<li>\"引数\": これには、メソッドが受け取る様々な引数を命名・記述した定義リスト（または順不同のリスト）を置く必要があります。オプションの引数の場合、引数名の隣に <span class=\"badge inline optional\">省略可</span> マクロを置く必要があります。引数がない場合、この項は省略してください。</li>\n<li>\"返値\": これはメソッドが持つ返値を示すもので、 double や論理値のような単純な値でも、別なインターフェイスのオブジェクトのような複雑な値でも構いません。この場合、 {{domxref}} マクロを使って、そのインターフェイスをカバーする MDN API ページに（存在すれば）リンクすることができます。メソッドは何も返さない場合がありますが、その場合、返値は \"{{jsxref('undefined')}}\" と記述します（レンダリングすると <a href=\"/ja/docs/Web/JavaScript/Reference/Global_Objects/undefined\"><code>undefined</code></a> と表示されます）。</li>\n<li>\"例外\": これは、そのメソッドを呼び出したときに発生する可能性のあるさまざまな例外と、その例外を発生させる状況を列挙してください。例外が発生しない場合は、この節は省略してください。</li>\n</ul>\n</li>\n<li>\n<p><strong>例</strong>: プロパティの典型的な使用方法を示すために、コードのリストを入れてください。すべてのコードを列挙するのではなく、そのうちの興味深い部分のみを並べてください。完全なコードのリストを紹介する場合は。例の全体を含んだ <a href=\"https://github.com/\" class=\"external\" target=\"_blank\">GitHub</a> リポジトリーを参照することができます。また、 <a href=\"https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site\" class=\"external\" target=\"_blank\">GitHub gh-pages</a> の機能を使って作成したライブサンプルにリンクすることもできます（もちろん、クライアント側のコードしか使用していなければですが）。サンプルが視覚的であれば、MDN <a href=\"/ja/docs/MDN/Writing_guidelines/Page_structures/Live_samples\">ライブサンプル</a> 機能を使ってページ内でライブ実行できるようにすることができます。</p>\n</li>\n<li>\n<p><strong>仕様書一覧表</strong>: ここに、仕様書一覧表を入れる必要があります。詳しくは「仕様書参照表の作成」の節をご覧ください。</p>\n</li>\n<li>\n<p><strong>ブラウザーの互換性</strong>: ここで、ブラウザーの互換性一覧表を入れる必要があります。詳しくは、<a href=\"/ja/docs/MDN/Writing_guidelines/Page_structures/Compatibility_tables\">互換性一覧表</a>を参照してください。</p>\n</li>\n</ol>\n<h4 id=\"メソッドページの例\">メソッドページの例</h4>\n<p>以下に、メソッドページの例を示します。</p>\n<ul>\n<li><a href=\"/ja/docs/Web/API/Document/getAnimations\"><code>Document.getAnimations</code></a> （<a href=\"/ja/docs/Web/API/Web_Animations_API\">ウェブアニメーション API</a>）</li>\n<li><a href=\"/ja/docs/Web/API/Window/fetch\" title=\"fetch()\"><code>fetch()</code></a> （<a href=\"/ja/docs/Web/API/Fetch_API\">フェッチ API</a>）</li>\n</ul>"}},{"type":"prose","value":{"id":"サイドバー","title":"サイドバー","isH3":false,"content":"<p>API リファレンスページを作成したら、ページを関連付けるために適切なサイドバーを挿入したくなるでしょう。 <a href=\"/ja/docs/MDN/Writing_guidelines/Howto/Write_an_api_reference/Sidebars\">API リファレンスサイドバー</a>のガイドで、その方法を説明します。</p>"}}],"isActive":true,"isMarkdown":true,"isTranslated":true,"locale":"ja","mdn_url":"/ja/docs/MDN/Writing_guidelines/Howto/Write_an_api_reference","modified":"2024-12-17T09:38:13.000Z","native":"日本語","noIndexing":false,"other_translations":[{"locale":"en-US","title":"How to write an API reference","native":"English (US)"},{"locale":"de","title":"Anleitung zum Schreiben einer API-Referenz","native":"Deutsch"},{"locale":"zh-CN","title":"如何撰写 API 参考文档","native":"中文 (简体)"}],"pageTitle":"API リファレンスの書き方 - MDN Web Docs プロジェクト | MDN","parents":[{"uri":"/ja/docs/MDN","title":"MDN Web Docs プロジェクト"},{"uri":"/ja/docs/MDN/Writing_guidelines","title":"執筆ガイドライン"},{"uri":"/ja/docs/MDN/Writing_guidelines/Howto","title":"How-to ガイド"},{"uri":"/ja/docs/MDN/Writing_guidelines/Howto/Write_an_api_reference","title":"API リファレンスの書き方"}],"popularity":null,"short_title":"API リファレンスの書き方","sidebarHTML":"<ol><li class=\"section\"><a href=\"/ja/docs/MDN\">MDN Web Docs プロジェクト</a></li><li><a href=\"/ja/docs/MDN/Tutorials\">チュートリアル</a></li><li><a href=\"/ja/docs/MDN/Guides\">開発者ガイド</a></li><li class=\"toggle\"><details><summary>Community resources</summary><ol><li><a href=\"/ja/docs/MDN/Community\">コミュニティガイドライン</a></li><li><a href=\"/ja/docs/MDN/Community/Getting_started\">MDN を始めよう</a></li><li><a href=\"/ja/docs/MDN/Community/Our_repositories\">MDN Web Docs のリポジトリー</a></li><li><a href=\"/ja/docs/MDN/Community/Open_source_etiquette\">オープンソースのエチケット</a></li><li><a href=\"/ja/docs/MDN/Community/Issues\">課題の作成と作業のガイドライン</a></li><li><a href=\"/ja/docs/MDN/Community/Pull_requests\">プルリクエストの提出とレビューのガイドライン</a></li><li><a href=\"/ja/docs/MDN/Community/Discussions\">コミュニティのディスカッション</a></li><li><a href=\"/ja/docs/MDN/Community/Translated_content\">MDN Web Docs のローカライズ</a></li><li><a href=\"/ja/docs/MDN/Community/Roles_teams\">MDN Web Docs の役割とチーム</a></li><li><a href=\"/ja/docs/MDN/Community/Communication_channels\">コミュニケーション手段</a></li><li><a href=\"/ja/docs/MDN/Community/Learn_forum\">学習フォーラム</a></li></ol></details></li><li class=\"toggle\"><details open=\"\"><summary>Writing guidelines</summary><ol><li><a href=\"/ja/docs/MDN/Writing_guidelines\">執筆ガイドライン</a></li><li><a href=\"/ja/docs/MDN/Writing_guidelines/What_we_write\">私たちが書くもの</a></li><li><a href=\"/ja/docs/MDN/Writing_guidelines/Writing_style_guide\">執筆スタイルガイド</a></li><li><a href=\"/en-US/docs/MDN/Writing_guidelines/Learning_content\" class=\"only-in-en-us\">Learning content guidelines</a></li><li><a href=\"/ja/docs/MDN/Writing_guidelines/Experimental_deprecated_obsolete\">実験的、非推奨、廃止</a></li><li><a href=\"/ja/docs/MDN/Writing_guidelines/Attrib_copyright_license\">帰属表示と著作権使用許諾</a></li><li class=\"toggle\"><details open=\"\"><summary>How-to guides</summary><ol><li><a href=\"/ja/docs/MDN/Writing_guidelines/Howto\">の概要</a></li><li><a href=\"/ja/docs/MDN/Writing_guidelines/Howto/Write_a_new_entry_in_the_glossary\">用語集の項目を執筆する方法</a></li><li><a href=\"/ja/docs/MDN/Writing_guidelines/Howto/Images_media\">画像やメディアの追加方法</a></li><li><a href=\"/ja/docs/MDN/Writing_guidelines/Howto/Creating_moving_deleting\">ページの作成、移動、削除、編集方法</a></li><li><a href=\"/ja/docs/MDN/Writing_guidelines/Howto/Document_a_CSS_property\">CSS プロパティの記事の作成方法</a></li><li><a href=\"/ja/docs/MDN/Writing_guidelines/Howto/Document_an_HTTP_header\">HTTP ヘッダーの記事の作成方法</a></li><li><a href=\"/ja/docs/MDN/Writing_guidelines/Howto/Document_web_errors\">ウェブのエラー記事の作成方法</a></li><li><a href=\"/ja/docs/MDN/Writing_guidelines/Howto/Research_technology\">技術の調査方法</a></li><li><a href=\"/ja/docs/MDN/Writing_guidelines/Howto/JSON_Structured_data\">構造化データの使用方法</a></li><li><em><a href=\"/ja/docs/MDN/Writing_guidelines/Howto/Write_an_api_reference\" aria-current=\"page\">API リファレンスの書き方</a></em></li><li><a href=\"/ja/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN\">Markdown の書き方</a></li></ol></details></li><li class=\"toggle\"><details><summary>Page structures</summary><ol><li><a href=\"/ja/docs/MDN/Writing_guidelines/Page_structures\">の概要</a></li><li><a href=\"/ja/docs/MDN/Writing_guidelines/Page_structures/Banners_and_notices\">バナーと注意</a></li><li><a href=\"/ja/docs/MDN/Writing_guidelines/Page_structures/Code_examples\">コードサンプル</a></li><li><a href=\"/ja/docs/MDN/Writing_guidelines/Page_structures/Compatibility_tables\">互換性一覧表とブラウザー互換性データリポジトリー (BCD)</a></li><li><a href=\"/ja/docs/MDN/Writing_guidelines/Page_structures/Feature_status\">機能状態</a></li><li><a href=\"/ja/docs/MDN/Writing_guidelines/Page_structures/Links\">リンクマクロ</a></li><li><a href=\"/ja/docs/MDN/Writing_guidelines/Page_structures/Live_samples\">ライブサンプル</a></li><li><a href=\"/ja/docs/MDN/Writing_guidelines/Page_structures/Page_types\">ページの種類</a></li><li><a href=\"/ja/docs/MDN/Writing_guidelines/Page_structures/Sidebars\">サイドバー</a></li><li><a href=\"/ja/docs/MDN/Writing_guidelines/Page_structures/Specification_tables\">仕様書一覧表</a></li><li><a href=\"/ja/docs/MDN/Writing_guidelines/Page_structures/Syntax_sections\">構文の節</a></li><li><a href=\"/ja/docs/MDN/Writing_guidelines/Page_structures/Macros\">マクロの使用</a></li></ol></details></li></ol></details></li></ol>","sidebarMacro":"mdnsidebar","source":{"folder":"ja/mdn/writing_guidelines/howto/write_an_api_reference","github_url":"https://github.com/mdn/translated-content/blob/main/files/ja/mdn/writing_guidelines/howto/write_an_api_reference/index.md","last_commit_url":"https://github.com/mdn/translated-content/commit/24c3a40584d521462c0a49f6f7cc01328c1a437f","filename":"index.md"},"summary":"このガイドでは、 MDN で API リファレンスを書くために必要なすべてのことを説明します。","title":"API リファレンスの書き方","toc":[{"text":"準備","id":"準備"},{"text":"ページの作成","id":"ページの作成"},{"text":"サイドバー","id":"サイドバー"}],"pageType":"mdn-writing-guide"}}</script></body></html>