website logo
⌘
K
Book a DemoSign Up ->
🌐
Help Center
💼
Jobs
🚀GETTING STARTED
👋Welcome to Archbee 🤓
Learn the basics
How to get started
📝EDITOR
📃DOCUMENTS
🗃️SPACES
🌎HOSTED SPACES
🔃PUBLIC API
GET
Get document
POST
Update / Create document
DELETE
Delete document
GET
Search document
☕ORGANIZATIONS
📦IMPORT & EXPORT
🔌INTEGRATIONS
📥GUIDES
➿MISC
🙋Q&A
Docs powered by
Archbee
IMPORT & EXPORT
Importing OpenAPI / Swagger

OpenAPI Settings

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

This is how to get to the settings page (click on the 3 dots near the imported OpenAPI):

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.

Document image


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

Sync Through API will need access to Archbee Public API, which is available in the ENTERPRISE plan.

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 change

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

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:

  1. cURL
  2. JS
  3. Python
  4. Ruby

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

1

Open the Language Change menu

Document image

2

To Add a new language just select it from the drop-down menu

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




Updated 22 Sep 2023
Did this page help you?
PREVIOUS
API Try It!
NEXT
Importing documents
Docs powered by
Archbee
TABLE OF CONTENTS
General
Sync Manually
Sync Through API
Language change
Docs powered by
Archbee