IMPORT _ EXPORT
Importing OpenAPI / Swagger
7 min
why use openapi import? if your product is built for developers or your product has an api, you need great product documentation — otherwise, you can't cut through to developers once you import your openapi file, archbee will read it and convert it to a beautiful ui and make it ready to be shared publicly (on a custom domain) internally with your colleagues and teams once imported, you can sync, update and test your openapi see more details in the sections below rules and default settings imported openapi files can not be manually modified in archbee to update and maintain your openapi, check our docid\ zn3rqi8ltb08srsi4cmrs supported openapi versions archbee currently supports the following openapi versions to be imported version 2 0 and 2 0 xx version 3 0 and 3 0 xx version 3 1 and 3 1 xx supported auth methods archbee currently supports the following auth methods https //swagger io/docs/specification/authentication/basic authentication/ https //swagger io/docs/specification/authentication/api keys/ https //swagger io/docs/specification/authentication/bearer authentication/ if you import openapi files with other auth methods, they will import correctly, and the auth method will be ignored this means that you will get the whole archbee openapi experience, except the try it! feature, if your endpoint requires an auth that is not in the list above others if you define a " default " parameters in your openapi and you give it a value, the code sample and the parameter box will be automatically pre populated with that value this makes it easy for your users or customers to test your api with docid\ noqnqlpwyykfjll x 3t0 without having to update all the required parameters if you define an " example " parameter in your openapi, the example value will be displayed on the left side just below the api parameter this makes it easy for your users to identify what type of input is needed for that specific parameter how does it work? import your openapi file using the import content or use import option from each space or sync your openapi files directly from your / /integrations/github md repository with archbee's / /integrations/github md you can add\&sync your openapi files directly from your repo preview and docid\ noqnqlpwyykfjll x 3t0 your imported openapi preview and test your newly imported openapi with archbee's docid\ noqnqlpwyykfjll x 3t0 feature publish or share it with your colleagues or customers! publish it to preview or on a custom domain and make it available to your colleagues, teams, or users if you would like to protect the content and only share it with a selected few, check out our / /hosted spaces/public access controls md options for published portals maintain, sync and configure it docid\ zn3rqi8ltb08srsi4cmrs docid\ zn3rqi8ltb08srsi4cmrs docid\ zn3rqi8ltb08srsi4cmrs here's a video of how it works