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 docid 3by3wouodwedmum pynq1 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 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 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 docid\ q9aot4lvq888diwpl46ns con la integración con github docid\ q9aot4lvq888diwpl46ns de archbee puedes añadir y sincronizar tus archivos openapi directamente desde tu repositorio previsualiza y probar docid\ q7wt hhmpa6 fh2y0ivho tu openapi importado previsualiza y prueba tu openapi recién importado con la función probar api docid\ q7wt hhmpa6 fh2y0ivho 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 mantenlo, sincronízalo y configúralo sincronizar manualmente docid 3by3wouodwedmum pynq1 sincronizar automáticamente vía api docid 3by3wouodwedmum pynq1 cambiar el lenguaje del código de ejemplo docid 3by3wouodwedmum pynq1 aquí hay un video de cómo funciona