Importación de OpenAPI / Swagger
¿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
Los archivos OpenAPI importados no pueden modificarse manualmente en Archbee.
Para actualizar y mantener tu OpenAPI, consulta nuestra opciones de sincronización
Versiones de OpenAPI compatibles:
Archbee actualmente admite las siguientes versiones de OpenAPI para importar:
- Versión 2.0 y 2.0.XX
- Versión 3.0 y 3.0.XX
- Versión 3.1 y 3.1.XX
Métodos de autenticación compatibles
Archbee actualmente admite los siguientes métodos de autenticación:
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
- 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 sin tener que actualizar todos los parámetros requeridos.
- 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.
¿Cómo funciona?
Importa tu archivo OpenAPI usando el Importar contenido:
O usa la opción Importar desde cada espacio:
O sincroniza tus archivos OpenAPI directamente desde tu repositorio de GitHub.
Con la Integración con GitHub de Archbee puedes añadir y sincronizar tus archivos OpenAPI directamente desde tu repositorio.
Previsualiza y probar tu OpenAPI importado
Previsualiza y prueba tu OpenAPI recién importado con la función PROBAR API.
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 para portales publicados.
Mantenlo, sincronízalo y configúralo: