---
title: Importación de OpenAPI / Swagger
slug: docs/es/importacion-de-openapi-swagger
description: Aprende cómo aprovechar la potencia de la importación de OpenAPI en Archbee para documentación de productos centrada en desarrolladores. Descubre los beneficios, las versiones compatibles, los métodos de autenticación, la pre‑población de parámetros prede
createdAt: 2021-10-29T07:42:12.000Z
---

## ¿Por qué usar la importación de OpenAPI?

Si su producto está creado para desarrolladores o su producto tiene una API, necesita una excelente documentación del producto; de lo contrario, no podrá llegar a los desarrolladores.

Una vez que importe su archivo OpenAPI, Archbee lo leerá y lo convertirá en una interfaz de usuario atractiva y lo dejará listo para:

- **Compartirse públicamente **(en un dominio personalizado) 
- **Internamente** con sus colegas y equipos

Una vez importado, puede sincronizar, actualizar y probar su OpenAPI. Consulte más detalles en las secciones a continuación.

## Reglas y configuraciones predeterminadas

:::hint{type="info"}
Los archivos OpenAPI importados no pueden modificarse manualmente en Archbee.

Para actualizar y mantener su OpenAPI, consulte nuestras [opciones de sincronización](docId:5gHO4yNloBkqOuoHDlgPc)
:::

### Versiones de OpenAPI compatibles:

Archbee actualmente admite las siguientes versiones de OpenAPI para ser importadas:

1. Versión 2.0 y 2.0.XX
2. Versión 3.0 y 3.0.XX
3. Versión 3.1  y 3.1.XX

### Métodos de autenticación compatibles

Archbee actualmente admite los siguientes métodos de autenticación:

1. [Autenticación básica](https://swagger.io/docs/specification/authentication/basic-authentication/)
2. [API Keys](https://swagger.io/docs/specification/authentication/api-keys/)
3. [Autenticación Bearer](https://swagger.io/docs/specification/authentication/bearer-authentication/)

Si importa archivos OpenAPI con otros métodos de autenticación, se importarán correctamente y el método de autenticación será ignorado. 

Esto significa que obtendrá toda la experiencia OpenAPI de Archbee, **excepto **la función Try It!, si su endpoint requiere una autenticación que no está en la lista anterior.

### Otros

1. Si define un parámetro "**predeterminado**" en su OpenAPI y le asigna un valor, el ejemplo de código y el cuadro de parámetros se rellenarán automáticamente con ese valor.

   Esto facilita que sus usuarios o clientes prueben su API con [¡Pruébalo!](docId:8jUzi20noJ2GDyz3q44vr) sin tener que actualizar todos los parámetros requeridos.

2. Si define un parámetro "**ejemplo**" en su OpenAPI, el valor del ejemplo se mostrará en el lado izquierdo justo debajo del parámetro de la API.

   Esto facilita que sus usuarios identifiquen qué tipo de entrada se necesita para ese parámetro específico.

![](https://api.archbee.com/api/optimize/bNBm7nPJgXjbjLyfbHNh2/fCN8X5XLW-WFI9W1yvi3K_body-light.png)

## ¿Cómo funciona?

::::WorkflowBlock
:::WorkflowBlockItem
Importe su archivo OpenAPI usando el **Importar contenido**:

![](https://api.archbee.com/api/optimize/bNBm7nPJgXjbjLyfbHNh2/ZIM8Bq-VEqGvv_aHHjArO_import-content-light.png)

O utilice la opción **Importar** desde cada espacio:

![](https://api.archbee.com/api/optimize/bNBm7nPJgXjbjLyfbHNh2/0w0sHacVm8l8N_AFkF4yf_import-option-light.png)

O sincronice sus archivos OpenAPI directamente desde su repositorio de [GitHub](docId\:kjqgM1uvSNMyHpLrtRza9) .

Con la [Integración con GitHub](docId\:kjqgM1uvSNMyHpLrtRza9) de Archbee usted puede agregar y sincronizar sus archivos OpenAPI directamente desde su repositorio.
:::

:::WorkflowBlockItem
Previsualice y [prueba](docId:8jUzi20noJ2GDyz3q44vr) su OpenAPI importado

![](https://api.archbee.com/api/optimize/bNBm7nPJgXjbjLyfbHNh2/DsF_NDr8yoe62d13qJDP6_test-it-light.png)

Previsualice y pruebe su OpenAPI recién importado con la función [API ¡PRUÉBALO!](docId:8jUzi20noJ2GDyz3q44vr) de Archbee.
:::

:::WorkflowBlockItem
**Públicar** o **compartirlo** con sus colegas o clientes.

Publíquelo en Preview o en un Dominio Personalizado y hágalo disponible para sus colegas, equipos o usuarios. 

Si desea proteger el contenido y solo compartirlo con un grupo seleccionado, revise nuestras opciones de [Controles de acceso público](docId\:ehXgwae9tjmwinTd8vFqF) para portales publicados.
:::

:::WorkflowBlockItem
Manténgalo, sincronícelo y configúrelo:

1. [Sincronízalo manualmente](docId:5gHO4yNloBkqOuoHDlgPc)
2. [Sincronizar automáticamente a través de la API](docId:5gHO4yNloBkqOuoHDlgPc)
3. [Cambiar el idioma del código de ejemplo](docId:5gHO4yNloBkqOuoHDlgPc)
:::
::::

## Aquí hay un video de cómo funciona

::embed[]{url="https://youtu.be/LQ3nEGCcdKg"}