Skip to main content
Puedes controlar qué operaciones de OpenAPI se publican como páginas de documentación y su visibilidad en la navegación. Esto es útil para endpoints internos, operaciones obsoletas, funciones beta o endpoints que deberían ser accesibles mediante una URL directa pero no detectables a través de la navegación del sitio. Si tus páginas se generan automáticamente a partir de un documento de OpenAPI, puedes gestionar la visibilidad de las páginas con las extensiones x-hidden y x-excluded.

x-hidden

La extensión x-hidden crea una página para un endpoint, pero la oculta de la navegación. La página solo es accesible si se accede directamente a su URL. Los casos de uso comunes de x-hidden son:
  • Endpoints que quieres documentar, pero no destacar.
  • Páginas a las que enlazarás desde otros contenidos.
  • Endpoints para usuarios específicos.

x-excluded

La extensión x-excluded excluye por completo un endpoint de tu documentación. Casos de uso comunes de x-excluded:
  • Endpoints internos.
  • Endpoints en desuso que no quieres documentar.
  • Funcionalidades beta que aún no están listas para la documentación pública.

Implementación

Añade la extensión x-hidden o x-excluded debajo del método HTTP en tu especificación de OpenAPI. A continuación se muestran ejemplos de cómo usar cada propiedad en un documento de esquema de OpenAPI para un endpoint y una ruta de webhook.