Plantilla de página de encabezado HTTP
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 el encabezado en cuestión.
---
title: Encabezado NombreDelEncabezado
short-title: NombreDelEncabezado
slug: Web/HTTP/Reference/Headers/NombreDelEncabezado
page-type: http-header
status:
- deprecated
- experimental
- non-standard
browser-compat: path.to.feature.NombreDelEncabezado
sidebar: http
---
- title
-
Encabezado del título que se muestra en la parte superior de la página. Formato: Encabezado NombreDelEncabezado. Por ejemplo, el encabezado Cache-Control tiene un title de
Cache-Control header. - short-title
-
Título abreviado que se usa en migas de pan y barras laterales. Formato: NombreDelEncabezado. Por ejemplo, el encabezado Cache-Control tiene un short-title de
Cache-Control. - slug
-
El final de la ruta URL después de
https://developer.mozilla.org/es/docs/. Tendrá el formatoWeb/HTTP/Reference/Headers/NombreDelEncabezado. Por ejemplo, el slug de Cache-Control esWeb/HTTP/Reference/Headers/Cache-Control. - page-type
-
Para encabezados HTTP, debe ser
http-header. - 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. 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.NombreDelEncabezadocon la cadena de consulta para el encabezado en el repositorio de datos de compatibilidad de navegadores. La cadena de herramientas usa automáticamente esta clave para rellenar la sección de compatibilidad (reemplazando la macro{{Compat}}).La compatibilidad con navegadores no aplica para encabezados HTTP sin implementación específica definida. En esos casos, elimina la clave
browser-compaty su valor. -
Siempre es
http. Consulta Estructuras de página: barras laterales para más detalles.
Macros de la parte superior de la página
Varias macros aparecen en la parte superior de la sección de contenido inmediatamente después del front matter. 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 el encabezado es experimental. Si es experimental y está oculto 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 el uso del encabezado está desaconsejado.{{Non-standard_Header}}— genera un banner de No estándar que indica que la funcionalidad no forma parte de ninguna especificación.
No proporciones macros de encabezado de estado manualmente. Consulta la sección "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 Experimental, Obsoleto y No estándar.
Recuerda eliminar toda esta nota explicativa antes de publicar.
Experimental: Esta es una tecnología experimental
Comprueba la Tabla de compabilidad de navegadores cuidadosamente antes de usarla en producción.
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.
La primera frase de la página debe seguir este formato:
El encabezado HTTP
nombre-del-encabezado(tipo de encabezado) se utiliza para X en circunstancias Y.
El "tipo de encabezado" debe indicar si es un encabezado de solicitud, un encabezado de respuesta, o si puede ser ambos. El párrafo de resumen debería ser idealmente una o dos frases cortas.
Puedes mencionar advertencias notables o errores comunes en esta sección, enlazando a ejemplos o documentación más detallada (guías, etc.). Dos o tres párrafos son apropiados para esta sección; si hay notas de uso sustanciales que incluir, usa una sección de "Descripción" después de "Directivas".
| Tipo de encabezado | Incluye la categoría (o categorías) del encabezado, p. ej. Encabezado de solicitud, Encabezado de respuesta, Client hint (Indicio del cliente) |
|---|---|
| Encabezado de solicitud prohibido | "Sí" o "No" |
| Encabezado de respuesta en lista blanca de CORS | "Sí" o "No" |
Sintaxis
Completa un bloque de sintaxis, como el de abajo, de acuerdo con la guía en nuestro artículo de secciones de sintaxis.
NombreDelEncabezado: <directiva1>
NombreDelEncabezado: <directiva1>, <directiva2>, …
Si el encabezado tiene muchas directivas disponibles, no dudes en incluir múltiples bloques de sintaxis, subsecciones y explicaciones según sea necesario:
NombreDelEncabezado: <directiva3>, …, <directivaN>
Las directivas no distinguen entre mayúsculas y minúsculas y tienen un argumento opcional que puede usar tanto la sintaxis de token como la de cadena entrecomillada (quoted-string). Las múltiples directivas se separan por comas (elimina la información según corresponda).
Directivas
directiva1-
Incluye aquí una breve descripción de la directiva y lo que hace. Incluye un término y una definición para cada directiva.
directiva2-
etc.
Si el encabezado tiene muchas directivas disponibles, puedes incluir múltiples listas de definiciones, subsecciones y explicaciones según sea necesario.
Descripción
Si hay demasiado contenido para incluirlo en los párrafos iniciales, proporciona aquí todo el detalle necesario, como información de trasfondo, consejos de uso y enlaces a la documentación. Este es un buen lugar para señalar si los patrones del mundo real difieren de lo especificado, en caso de que las implementaciones ampliamente desplegadas se desvíen de lo descrito en las especificaciones.
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
Si el navegador no tiene un manejo específico para el encabezado, elimina la macro de abajo. De lo contrario, para usar esta macro, elimina las comillas invertidas y la barra invertida en el archivo markdown.
{{Compat}}
Si el navegador tiene un manejo específico para el encabezado, elimina el texto de abajo:
Este encabezado no tiene una integración con el agente de usuario definida por la especificación (la "compatibilidad con navegadores" no se aplica).
Los desarrolladores pueden establecer y obtener encabezados HTTP usando fetch() para proporcionar un comportamiento de implementación específico de la aplicación.
Véase también
Incluye enlaces a páginas de referencia y guías relacionadas con el encabezado HTTP actual. Para más pautas, consulta la sección Véase también en la Guía de estilo de escritura.
Puedes enlazar a estados de respuesta relevantes como {{HTTPStatus("123", "123 Motivo")}} y encabezados como {{HTTPHeader("Nombre-Del-Encabezado")}}. Puedes agrupar estados y encabezados relacionados en un solo elemento de la lista para mayor brevedad.
- enlace1
- enlace2
- enlace_externo (año)