---
title: Importación de OpenAPI / Swagger
slug: importacion-de-openapi-swagger
description: Aprende cómo aprovechar el poder 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 predeter
createdAt: 2021-10-29T07:42:12.000Z
---

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

Si tu producto está creado para desarrolladores o tiene una API, necesitas una gran documentación del producto; de lo contrario, no podrás llegar a los desarrolladores.

Una vez que importes tu archivo OpenAPI, Archbee lo leerá y lo convertirá en una hermosa interfaz lista para ser:

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

Una vez importado, puedes sincronizar, actualizar y probar tu OpenAPI. Consulta más detalles en las secciones siguientes.

## Reglas y configuraciones predeterminadas

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

Para actualizar y mantener tu OpenAPI, consulta nuestra [opciones de sincronización](docId:3By3WoUODWEDMum_pYNq1)
:::

### Versiones de OpenAPI compatibles:

Archbee actualmente admite las siguientes versiones de OpenAPI para importar:

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. [Claves API](https://swagger.io/docs/specification/authentication/api-keys/)
3. [Autenticación Bearer](https://swagger.io/docs/specification/authentication/bearer-authentication/)

Si importas 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ás toda la experiencia OpenAPI de Archbee, **excepto **la función Try It!, si tu endpoint requiere una autenticación que no esté en la lista anterior.

### Otros

1. Si defines parámetros "**predeterminados**" en tu OpenAPI y les asignas un valor, el ejemplo de código y el cuadro de parámetros se rellenarán automáticamente con ese valor.

   Esto facilita que tus usuarios o clientes prueben tu API con [Probarlo](docId\:Q7WT-hhmpA6_Fh2y0ivhO) sin tener que actualizar todos los parámetros requeridos.

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

   Esto facilita que tus 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
Importa tu archivo OpenAPI usando el **Importar contenido**:

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

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

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

O sincroniza tus archivos OpenAPI directamente desde tu repositorio de [GitHub](docId\:q9AOt4Lvq888dIWPl46NS).

Con la [Integración con GitHub](docId\:q9AOt4Lvq888dIWPl46NS) de Archbee puedes añadir y sincronizar tus archivos OpenAPI directamente desde tu repositorio.
:::

:::WorkflowBlockItem
Previsualiza y [probar](docId\:Q7WT-hhmpA6_Fh2y0ivhO) tu OpenAPI importado

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

Previsualiza y prueba tu OpenAPI recién importado con la función [PROBAR API](docId\:Q7WT-hhmpA6_Fh2y0ivhO).
:::

:::WorkflowBlockItem
**Publica** o **compártelo** con tus colegas o clientes.

Publícalo en vista previa o en un dominio personalizado y ponlo a disposición de tus colegas, equipos o usuarios.

Si deseas proteger el contenido y compartirlo solo con algunos seleccionados, revisa nuestras opciones de [Controles de acceso público](docId\:Ok0ZudAh9RZS3_baFhfQv) para portales publicados.
:::

:::WorkflowBlockItem
Mantenlo, sincronízalo y configúralo:

1. [Sincronizar manualmente](docId:3By3WoUODWEDMum_pYNq1)
2. [Sincronizar automáticamente vía API](docId:3By3WoUODWEDMum_pYNq1)
3. [Cambiar el lenguaje del código de ejemplo](docId:3By3WoUODWEDMum_pYNq1)
:::
::::

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

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