Importación de OpenAPI / Swagger
7 min
¿por qué usar la importación de openapi? si tu producto está creado para desarrolladores o tu producto tiene una api, necesitas una excelente documentación — 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 interfaz hermosa y lo dejará listo para compartirse 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 a continuación 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 docid 5gho4ynlobkqouohdlgpc 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 autenticación básica https //swagger io/docs/specification/authentication/basic authentication/ claves api https //swagger io/docs/specification/authentication/api keys/ 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 si defines parámetros " predeterminados " en tu openapi y les das un valor, el ejemplo de código y la caja de parámetros se completarán automáticamente con ese valor esto facilita que tus usuarios o clientes prueben tu api con probar docid 8juzi20noj2gdyz3q44vr sin tener que actualizar todos los parámetros requeridos si define un parámetro " ejemplo " en su openapi, el valor de 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? importa tu archivo openapi usando importar contenido o usa la opción importar en cada espacio o sincroniza tus archivos openapi directamente desde tu repositorio de github docid\ kjqgm1uvsnmyhplrtrza9 con la integración de archbee con integración de github docid\ kjqgm1uvsnmyhplrtrza9 puedes añadir y sincronizar tus archivos openapi directamente desde tu repositorio previsualiza y probar docid 8juzi20noj2gdyz3q44vr tu openapi importado previsualiza y prueba tu openapi recién importado con la función probar api docid 8juzi20noj2gdyz3q44vr 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 solo compartirlo con un grupo seleccionado, revisa nuestras opciones de controles de acceso público docid\ ehxgwae9tjmwintd8vfqf para portales publicados mantén, sincroniza y configúralo sincronizar manualmente docid 5gho4ynlobkqouohdlgpc sincronizar automáticamente vía api docid 5gho4ynlobkqouohdlgpc cambiar el lenguaje del código de ejemplo docid 5gho4ynlobkqouohdlgpc aquí hay un video de cómo funciona
Have a question?
Our super-smart AI, knowledgeable support team and an awesome community will get you an answer in a flash.
To ask a question or participate in discussions, you'll need to authenticate first.
