Importación de OpenAPI / Swagger
¿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
Los archivos OpenAPI importados no pueden modificarse manualmente en Archbee.
Para actualizar y mantener su OpenAPI, consulte nuestras opciones de sincronización
Versiones de OpenAPI compatibles:
Archbee actualmente admite las siguientes versiones de OpenAPI para ser importadas:
- 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:
- API Keys
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
- 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! sin tener que actualizar todos los parámetros requeridos.
- 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.
¿Cómo funciona?
Importe su archivo OpenAPI usando el Importar contenido:
O utilice la opción Importar desde cada espacio:
O sincronice sus archivos OpenAPI directamente desde su repositorio de GitHub .
Con la Integración con GitHub de Archbee usted puede agregar y sincronizar sus archivos OpenAPI directamente desde su repositorio.
Previsualice y prueba su OpenAPI importado
Previsualice y pruebe su OpenAPI recién importado con la función API ¡PRUÉBALO! de Archbee.
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 para portales publicados.
Manténgalo, sincronícelo y configúrelo: