Descripción de OpenAPI

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

Acerca de las descripciones de OpenAPI

OpenAPI es una especificación estándar para describir las API de 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

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

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ías:

  • 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 utilizando herramientas de terceros tales como Insomnia o Postman.

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

¿Te ayudó este documento?

Política de privacidad

¡Ayúdanos a hacer geniales estos documentos!

Todos los documentos de GitHub son de código abierto. ¿Notas algo que esté mal o que no sea claro? Emite una solicitud de cambios.

Haz una contribución

O, aprende cómo contribuir.