Importar una API
Restorm reconoce veinticuatro formatos y reconstruye a partir de ellos un árbol de proyecto completo: carpetas, peticiones, entornos, documentación de API, enumeraciones.
Casi siempre es el mejor punto de partida: no escriba sus peticiones a mano si existe una especificación.
Cómo importar
Section titled “Cómo importar”Archivo ▸ Importar (Ctrl+I) acepta:
- un archivo del disco;
- una URL, útil para un
swagger.jsono un$metadataservido en línea; - contenido pegado: así es como se convierte un comando
curlen una petición.
Restorm detecta el formato por sí solo: primero según la extensión del archivo y después analizando el contenido. No tiene que elegir nada.
Los formatos
Section titled “Los formatos”Especificaciones de API
Section titled “Especificaciones de API”| Formato | Página |
|---|---|
| OpenAPI 3.x y Swagger 2.0 | OpenAPI / Swagger |
| Esquema GraphQL (SDL) | GraphQL |
Archivos .proto y reflexión gRPC | gRPC |
| WSDL | SOAP / WSDL |
| AsyncAPI | AsyncAPI |
| OData EDMX / CSDL | OData |
| OpenRPC | OpenRPC |
| Esquema tRPC | tRPC |
| Smithy | Smithy |
| TypeSpec | TypeSpec |
| RAML | RAML |
| WADL | WADL |
| Thrift | Thrift |
| API Blueprint | API Blueprint |
Colecciones de otros clientes
Section titled “Colecciones de otros clientes”| Formato | Página |
|---|---|
| Postman | Postman |
| Insomnia | Insomnia |
| Bruno | Bruno |
| Thunder Client | Thunder Client |
| Paw / RapidAPI | Paw |
| HTTPie | HTTPie |
VS Code REST Client (.http) | REST Client |
Capturas y líneas de comandos
Section titled “Capturas y líneas de comandos”| Formato | Página |
|---|---|
| HAR (captura del navegador) | HAR |
Comandos curl | cURL |
Invoke-RestMethod / Invoke-WebRequest | PowerShell |
Lo que obtiene
Section titled “Lo que obtiene”Según la riqueza del formato de origen:
- una carpeta de variables con uno o varios entornos y la URL base extraída de la especificación;
- un árbol de carpetas: por etiqueta, por servicio o por recurso según el formato;
- una petición por operación, del tipo correspondiente al protocolo;
- la documentación de API adjunta a la carpeta: modelos, descripciones, esquemas de seguridad, respuestas de ejemplo;
- las enumeraciones de la especificación, reutilizables como tipo de valor;
- las cabeceras de autenticación preconfiguradas con sus variables: consulte Autenticación.
Después de la importación, todo par clave / valor cuyo valor se resuelva como vacío se desactiva automáticamente: su primer envío no sale, por tanto, con un enjambre de cabeceras vacías.
La documentación de la API importada
Section titled “La documentación de la API importada”Una importación no produce solo peticiones: conserva la documentación de la API —descripciones, modelos, seguridad, ejemplos, enumeraciones— consultable en la pestaña Docs de la carpeta creada. Consulte Acceso y actualización de la documentación de una API importada.
Actualizar una importación
Section titled “Actualizar una importación”Doce formatos admiten la resincronización: Restorm compara la nueva versión del origen con el árbol existente y aplica el delta, sin perder sus modificaciones. Consulte Actualizar desde el origen.
¿Y la exportación?
Section titled “¿Y la exportación?”Restorm genera fragmentos de código para cada petición, en todos los lenguajes pertinentes para su protocolo. Consulte Exportación de código.