Plantilla de página de referencia de API
Nota: Elimina toda esta nota explicativa antes de publicar.
Front matter de la página:
El front matter al principio de la página se usa para definir los "metadatos de la página". Los valores deben actualizarse adecuadamente para la propiedad en cuestión.
---
title: NameOfTheInterface
slug: Web/API/NameOfTheInterface
page-type: web-api-interface
status:
- deprecated
- experimental
- non-standard
browser-compat: path.to.feature.NameOfTheInterface
---
- title
-
Encabezado del título que se muestra en la parte superior de la página. Es solo el nombre de la interfaz. Por ejemplo, la página de la interfaz Request tiene un title de Request.
- slug
-
El final de la ruta URL después de
https://developer.mozilla.org/es/docs/. Tendrá el formatoWeb/API/NameOfTheParentInterface. Por ejemplo, el slug de Request esWeb/API/Request. - page-type
-
La clave
page-typepara interfaces Web/API siempre esweb-api-interface. - status
-
Indicadores que describen el estado de esta funcionalidad. Es un arreglo que puede contener uno o más de los siguientes valores:
experimental,deprecated,non-standard. Esta clave no debe configurarse manualmente: se establece automáticamente según los valores en los datos de compatibilidad de navegadores para la funcionalidad. Consulta "Cómo se añaden o actualizan los estados de las funcionalidades". - browser-compat
-
Reemplaza el valor de marcador de posición
path.to.feature.NameOfTheMethodcon la cadena de consulta para el método en el repositorio de datos de compatibilidad de navegadores. La cadena de herramientas usa automáticamente esta clave para rellenar las secciones de compatibilidad y especificaciones (reemplazando las macros{{Compat}}y{{Specifications}}).
Ten en cuenta que es posible que primero necesites crear o actualizar una entrada para el método de API en nuestro repositorio de datos de compatibilidad de navegadores, y dicha entrada debe incluir información de especificación.
Consulta nuestra guía sobre cómo hacerlo.
Macros de la parte superior de la página
Varias llamadas a macros aparecen en la parte superior de la sección de contenido (inmediatamente después del front matter de la página).
Estas macros se añaden automáticamente mediante la cadena de herramientas (no es necesario añadirlas ni eliminarlas):
{{SeeCompatTable}}— genera un banner de Esta es una tecnología experimental que indica que la tecnología es experimental. Si es experimental y está oculta detrás de una preferencia en Firefox, también debes completar una entrada en la página Funcionalidades experimentales en Firefox.{{Deprecated_Header}}— genera un banner de Obsoleto que indica que la tecnología está obsoleta.{{Non-standard_Header}}— genera un banner de No estándar que indica que la funcionalidad no forma parte de ninguna especificación.
Debes actualizar o eliminar las siguientes macros según las indicaciones a continuación:
{{SecureContext_Header}}— genera un banner de Contexto seguro que indica que la tecnología solo está disponible en un contexto seguro. Si no lo está, puedes eliminar la llamada a la macro. Si lo está, también debes completar una entrada en la página Funcionalidades restringidas a contextos seguros.{{AvailableInWorkers}}— genera una nota de Disponible en workers que indica que la tecnología está disponible en el contexto de workers. Si solo está disponible en el contexto de window, puedes eliminar la llamada a la macro.{{APIRef("GroupDataName")}}— genera la barra lateral de referencia a la izquierda con enlaces de referencia rápida relacionados con la página actual. Consulta nuestra guía de barras laterales de referencia de API para saber cómo hacerlo.
No añadas manualmente macros de encabezado de estado. Consulta "Cómo se añaden o actualizan los estados de las funcionalidades" para añadir estos estados a la página.
Justo después de este bloque de notas se muestran ejemplos de los banners de Contexto seguro, Disponible en workers, Experimental, Obsoleto y No estándar.
Recuerda eliminar toda esta nota explicativa antes de publicar.
Contexto seguro: Esta función está disponible solo en contextos seguros (HTTPS), en algunos o todos los navegadores que lo soportan.
Nota: Esta característica está disponible en Web Workers.
Experimental: Esta es una tecnología experimental
Comprueba la Tabla de compabilidad de navegadores cuidadosamente antes de usarla en producción.
Obsoleto: Esta característica ya no se recomienda. Aunque es posible que algunos navegadores aún lo admitan, probablemente ya se ha eliminado de los estándares web relevantes, está en proceso de eliminación o solo se conserva por motivos de compatibilidad. Evite usarlo y actualice el código existente si es posible; consulte la tabla de compatibilidad en la parte inferior de esta página para orientar su decisión. Tenga en cuenta que esta característica puede dejar de funcionar en cualquier momento.
No estándar: Esta función no está estandarizada. No recomendamos usar funciones no estándar en producción, ya que tienen un soporte limitado en los navegadores y pueden cambiar o eliminarse. Sin embargo, pueden ser una alternativa adecuada en casos específicos donde no exista una opción estándar.
El párrafo de resumen: comienza nombrando la interfaz, indicando a qué API pertenece y qué hace. Idealmente debería ser una o dos frases cortas. Puedes copiar gran parte de esto desde el resumen de la interfaz en la página de aterrizaje de la API correspondiente.
{{InheritanceDiagram}}
Para usar el macro domxref en las secciones siguientes, elimina las comillas invertidas y la barra invertida en el archivo markdown.
Constructor
{{DOMxRef("NameOfTheInterface.NameOfTheInterface", "NameOfTheInterface()")}}-
Crea una nueva instancia del objeto
NameOfTheInterface.
Propiedades estáticas
También hereda propiedades de su interfaz padre, {{DOMxRef("NameOfParentInterface")}}. (Nota: si la interfaz no hereda de otra interfaz, elimina toda esta línea.)
Incluye un término y una definición para cada propiedad.
{{DOMxRef("NameOfTheInterface.staticProperty1")}}Read only-
Incluye aquí una breve descripción de la propiedad y lo que hace. Si la propiedad no es de solo lectura/experimental/obsoleta/no estándar, elimina las llamadas a macros correspondientes.
{{DOMxRef("NameOfTheInterface.staticProperty2")}}-
Incluye aquí una breve descripción de la propiedad y lo que hace. Si la propiedad no es de solo lectura/experimental/obsoleta/no estándar, elimina las llamadas a macros correspondientes.
Propiedades de instancia
También hereda propiedades de su interfaz padre, {{DOMxRef("NameOfParentInterface")}}. (Nota: si la interfaz no hereda de otra interfaz, elimina toda esta línea.)
Incluye un término y una definición para cada propiedad.
{{DOMxRef("NameOfTheInterface.property1")}}Read only-
Incluye aquí una breve descripción de la propiedad y lo que hace. Si la propiedad no es de solo lectura/experimental/obsoleta/no estándar, elimina las llamadas a macros correspondientes.
{{DOMxRef("NameOfTheInterface.property2")}}-
Incluye aquí una breve descripción de la propiedad y lo que hace. Si la propiedad no es de solo lectura/experimental/obsoleta/no estándar, elimina las llamadas a macros correspondientes.
Métodos estáticos
También hereda métodos de su interfaz padre, {{DOMxRef("NameOfParentInterface")}}. (Nota: si la interfaz no hereda de otra interfaz, elimina toda esta línea.)
Incluye un término y una definición para cada método.
{{DOMxRef("NameOfTheInterface.staticMethod1()")}}-
Incluye aquí una breve descripción del método y lo que hace. Si el método no es experimental/obsoleto/no estándar, elimina las llamadas a macros correspondientes.
{{DOMxRef("NameOfTheInterface.staticMethod2()")}}-
Incluye aquí una breve descripción del método y lo que hace. Si el método no es experimental/obsoleto/no estándar, elimina las llamadas a macros correspondientes.
Métodos de instancia
También hereda métodos de su interfaz padre, {{DOMxRef("NameOfParentInterface")}}. (Nota: si la interfaz no hereda de otra interfaz, elimina toda esta línea.)
Incluye un término y una definición para cada método.
{{DOMxRef("NameOfTheInterface.method1()")}}-
Incluye aquí una breve descripción del método y lo que hace. Si el método no es experimental/obsoleto/no estándar, elimina las llamadas a macros correspondientes.
{{DOMxRef("NameOfTheInterface.method2()")}}-
Incluye aquí una breve descripción del método y lo que hace. Si el método no es experimental/obsoleto/no estándar, elimina las llamadas a macros correspondientes.
Eventos
También hereda eventos de su interfaz padre, {{DOMxRef("NameOfParentInterface")}}. (Nota: si la interfaz no hereda de otra interfaz, elimina toda esta línea.)
Escucha estos eventos usando addEventListener() o asignando un detector de eventos a la propiedad oneventname de esta interfaz.
{{DOMxRef("NameOfTheInterface.event1", "event1")}}-
Se dispara cuando (incluye la descripción de cuándo se dispara el evento). También disponible a través de la propiedad
oneventname1. Si el evento no es experimental/obsoleto/no estándar, elimina las llamadas a macros correspondientes. {{DOMxRef("NameOfTheInterface.event2", "event2")}}-
Se dispara cuando (incluye la descripción de cuándo se dispara el evento). También disponible a través de la propiedad
oneventname2. Si el evento no es experimental/obsoleto/no estándar, elimina las llamadas a macros correspondientes.
Ejemplos
Ten en cuenta que usamos el plural "Ejemplos" incluso si la página solo contiene un ejemplo.
Un encabezado descriptivo
Cada ejemplo debe tener un encabezado H3 (###) que nombre el ejemplo. El encabezado debe ser descriptivo de lo que hace el ejemplo. Por ejemplo, "Un ejemplo simple" no dice nada sobre el ejemplo y, por lo tanto, no es un buen encabezado. El encabezado debe ser conciso. Para una descripción más larga, usa el párrafo después del encabezado.
Consulta nuestra guía sobre cómo añadir ejemplos de código para más información.
Nota: A veces querrás enlazar a ejemplos dados en otra página.
Escenario 1: Si tienes algunos ejemplos en esta página y algunos más en otra página:
Incluye un encabezado H3 (###) para cada ejemplo en esta página y luego un encabezado H3 final (###) con el texto "Más ejemplos", bajo el cual puedes enlazar a los ejemplos en otras páginas. Por ejemplo:
## Ejemplos
### Uso de la API fetch
Ejemplo de Fetch
### Más ejemplos
Enlaces a más ejemplos en otras páginas
Escenario 2: Si solo tienes ejemplos en otra página y ninguno en esta:
No añadas encabezados H3; simplemente añade los enlaces directamente bajo el encabezado H2 "Ejemplos". Por ejemplo:
## Ejemplos
Para ver ejemplos de esta API, consulta [la página sobre fetch()](https://example.org/).
Especificaciones
{{Specifications}}
Para usar esta macro, elimina las comillas invertidas y la barra invertida en el archivo markdown.
Compatibilidad con navegadores
{{Compat}}
Para usar esta macro, elimina las comillas invertidas y la barra invertida en el archivo markdown.
Véase también
Incluye enlaces a páginas de referencia y guías relacionadas con la API actual. Para más pautas, consulta la sección Véase también en la Guía de estilo de escritura.
- enlace1
- enlace2
- enlace_externo (año)