Importar OpenAPI / Swagger
Es la importación más completa de Restorm. Se reconocen tres versiones: Swagger 2.0, OpenAPI 3.0 y OpenAPI 3.1.
Importar
Section titled “Importar”Archivo ▸ Importar (Ctrl+I) y después un archivo swagger.json /
openapi.json, o directamente la URL de la especificación.
Si la URL responde 401 o 403, Restorm le propone asociar una autenticación y volver
a intentarlo, sin salir de la ventana modal de importación.
Lo que se importa
Section titled “Lo que se importa”| Elemento de la especificación | Lo que Restorm hace con él |
|---|---|
servers (o host + basePath + schemes) | La URL base del entorno, con las variables de servidor resueltas |
tags | Una carpeta por etiqueta, más una carpeta Other para el resto |
| Cada operación | Una petición HTTP, método y ruta incluidos |
| Parámetros | Parámetros de ruta, de consulta y cabeceras, tipados (cadena, número, fecha-hora, enumeración, secreto…) |
requestBody | El cuerpo, en su tipo de contenido |
examples | El cuerpo rellenado previamente con el ejemplo proporcionado |
components / definitions | La documentación de API: modelos, descripciones |
enum | Enumeraciones reutilizables como tipo de valor |
| Respuestas | Documentadas por tipo de contenido |
Las $ref se resuelven, incluso a través de los componentes.
La línea components / definitions merece destacarse: la importación no se limita a
las peticiones, conserva toda la documentación de la API —descripciones, modelos,
esquemas de seguridad, ejemplos, enumeraciones—. Se puede consultar en la pestaña
Docs de la carpeta de variables procedente de la importación, igual que en la de
cada petición, y se resincroniza desde el origen. Consulte
Acceso y actualización de la documentación de una API importada.
Seguridad
Section titled “Seguridad”Los esquemas de seguridad declarados se traducen a cabeceras o parámetros preconfigurados, con la variable de entorno correspondiente creada para usted:
| Esquema | Lo que Restorm coloca |
|---|---|
apiKey en cabecera o en consulta | Un par nombrado según el esquema, con valor {{<schema>}} |
http + basic | Authorization: Basic {{<schema>_credentials}} |
http + bearer, oauth2, openIdConnect | Authorization: Bearer {{<schema>_token}} |
Solo queda rellenar la variable, o sustituirla por una ruta de autenticación para disfrutar de la renovación automática.
Actualizar
Section titled “Actualizar”OpenAPI y Swagger figuran entre los formatos resincronizables: el botón Actualizar de la carpeta recupera el origen y Restorm aplica el delta —operaciones nuevas añadidas, operaciones desaparecidas marcadas como obsoletas en lugar de eliminadas, sus modificaciones conservadas—. Consulte Actualizar desde el origen.