Crear una referencia de API
Crea una referencia de API en tu centro de ayuda a partir de una especificación OpenAPI, Swagger 2.0, GraphQL SDL o JSON de introspección de GraphQL. Puedes cargar un archivo, leer la especificación desde un repositorio de GitHub o recuperarla de una URL. Para crear y publicar una referencia de API necesitas una suscripción activa o de prueba, y los archivos de especificación deben ocupar menos de 15 MB.
Añadir una referencia de API
Ve a la página Centro de ayuda en el panel de control.
En el encabezado de una sección, haz clic en el botón para añadir contenido y selecciona Crear referencia de API.
En el cuadro de diálogo Añadir referencia de API, elige una fuente: Cargar un archivo, Desde GitHub o Desde una URL.
Cargar un archivo de especificación
La carga admite archivos JSON o YAML de OpenAPI y archivos de esquema de GraphQL con la extensión .graphql, .gql o .graphqls. Selecciona Cargar un archivo y elige tu archivo de especificación.
Añadir una especificación desde una URL
Usa esta opción cuando tu especificación ya esté alojada en línea. La URL puede apuntar a un documento OpenAPI, un archivo GraphQL SDL o un endpoint de GraphQL.
Selecciona Desde una URL.
Introduce la URL de tu especificación o endpoint de GraphQL.
Los endpoints de GraphQL necesitan tener habilitada la introspección. Las fuentes URL se actualizan automáticamente cada seis horas.
Si la URL de tu especificación proviene de Stainless, las páginas generadas pueden mostrar fragmentos de código del SDK.
Añadir una especificación desde GitHub
Lee el archivo de especificación directamente desde un repositorio en cada sincronización. La conexión de GitHub debe pertenecer al mismo espacio de trabajo y tener acceso al repositorio.
Selecciona Desde GitHub.
Selecciona una conexión de GitHub. Si aún no has conectado GitHub, configúralo primero en integración de GitHub.
Selecciona el repositorio.
Opcionalmente, elige una rama o confirmación. Cuando está disponible, se utiliza la rama de producción configurada; de lo contrario, se utiliza la rama predeterminada de GitHub del repositorio.
Introduce la ruta relativa al repositorio del archivo de especificación.
Haz clic en Comprobar especificación y espera a que la comprobación se complete correctamente.
La comprobación de la especificación debe completarse correctamente antes de que puedas crear la referencia de API desde GitHub.
Configurar y crear
Introduce un slug de URL para la referencia.
Elige si quieres usar Publicar inmediatamente.
Haz clic en Añadir referencia de API.
El procesamiento suele tardar unos segundos. Cuando la especificación está lista, aparece Tu referencia de API está lista; haz clic en Listo para terminar. Si el procesamiento falla, aparece Error de procesamiento; haz clic en Cerrar para cerrar el cuadro de diálogo.
Qué sigue
Mantén actualizada la fuente en Reemplazar la especificación de una referencia de API y Actualizar las fuentes de referencias de API, y ajusta la barra lateral y las páginas de operaciones en Personalizar una referencia de API.