IMPORT & EXPORT
Importing OpenAPI / Swagger

OpenAPI Settings

8min

The OpenAPI Settings is the place where you can configure your imported OpenAPI file.

How to get to the OpenAPI Settings

1

Go to the Space and click the 3 dots ⫶

2

Now click on Open API Settings

Document image



General

The General tab of the OpenAPI Settings will allow you to:

  • Enable/disable the API Try It! feature (by default, this feature is enabled)
  • Show download Open API link
  • Create Models Category
  • Write API Intro


Sync Manually

The Sync Manually tab allows you to manually update your API file.

You can either add it from your local storage, or you can provide an URL to your file and Archbee will update it.

Document image



Sync Through API

The Sync Through API allows you to use our public API to sync the OpenAPI file.

This is a powerfull tool since it allows you to integrate it with your CI/CD and make automatic updates depending on your dev/deployment process.

Document image



Language Examples

From the language change you can change the programming language the code sample is shown in.

Document image


Each imported OpenAPI file has either on the right side or below a code drawer that contains the sample code of the API request.

By default this sample code is displayed in 4 programming languages:

  • cURL
  • JS
  • Python
  • Ruby

In the Language Change menu, you can update this settings and this is how:

1

Open the Language Example tab

2

To add a new language just select it from the drop-down menu or to remove a language just click the "X" button near it;

Document image

3

Close the menu and check out the updated code drawer & code samples

Document image




🤔
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.



Updated 06 Nov 2024
Doc contributor
Doc contributor
Doc contributor
Did this page help you?