Skip to main content

Esta versión de GitHub Enterprise se discontinuará el 2022-09-28. No se realizarán lanzamientos de patch, ni siquiera para problemas de seguridad críticos. Para obtener rendimiento mejorado, seguridad mejorada y nuevas características, actualice a la versión más reciente de GitHub Enterprise. Para obtener ayuda con la actualización, póngase en contacto con el soporte técnico de GitHub Enterprise.

Descripción de OpenAPI

La API de REST de GitHub Enterprise Server se describe íntegramente en un documento compatible con OpenAPI 3.0.

Acerca de las descripciones de OpenAPI

OpenAPI es una especificación estándar que se usa para describir las API REST. Las descripciones de OpenAPI permiten tanto a los humanos como a las máquinas descubrir las capacidades de una API sin la necesidad de leer documentación o entender la implementación. GitHub ha puesto si API de REST disponible para el público en general como un documento compatible con OpenAPI 3.0.

Obtener la descricpión de OpenAPI de GitHub

Puede encontrar la descripción en el repositorio REST API OpenAPI Description de código abierto.

Proporcionamos la descripción en dos formatos. La versión en paquete funciona para la mayoría de los casos, ya que incluye componentes de OpenAPI para reutilización y legibilidad. Si tus herramientas no son compatibles con las referencias a los componentes dentro de las líneas, también te proporcionamos una versión completamente desreferenciada.

Utilizar la descripción de OpenAPI de GitHub

Hay muchos tipos de uso para la descripción de OpenAPI. Por ejemplo, podría realizar estas acciones:

  • Generar tu propio cliente de API.
  • Validar y probar una ingegración a la API de REST de GitHub.
  • Explorar e interactuar con la API de REST de GitHub Enterprise Server utilizando herramientas de terceros tales como Insomnia o Postman.

Por ejemplo, GitHub usa la descripción de OpenAPI de REST para generar la documentación de referencia de la API REST de GitHub Enterprise Server.