Importing OpenAPI / Swagger
This feature is available on these plans:
✔️ Starter ✔️ Growing ✔️ Scaling ✔️ Enterprise
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.
Imported OpenAPI files can not be manually modified in Archbee.
To update and maintain your OpenAPI, check our sync options
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
Archbee currently supports the following Auth methods:
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.
- 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 Try It! withoud 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.
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 Public Access Controls options for published portals.