REST query import

The REST query import feature allows you to import one or more queries at a time.

The supported formats for import are:

  • Swagger 2.0 / OpenAPI 2.0 (YAML or JSON)
  • Swagger 3.0 / OpenAPI 3.0 (YAML or JSON)
  • CURL

ย 


ย 

Import collection

File

Upload a file containing your API documentation.

ย 

Text

Enter the documentation string directly.

ย  ย 


ย 

Converting and importing a Postman collection

As Postman does not natively use OpenAPI, you will need to generate an OpenAPI definition before importing it into Budibase.

Find the collection in Postman that you want to export. Click the ... and select Export.

Exporting an API collection in Postman

Exporting an API collection in Postman

This will download a JSON file with the API configuration.

We now need to convert this collection to an OpenAPI definition. We can do that with the handy postman2openapi tool.

In Budibase, add a new REST API datasource, or select an existing one. Under the Queries tab, click Import.

Click on the Raw Text tab and paste in the newly generated OpenAPI definition. Click Import.

You will now see the imported requests listed:

Imported API collection

Imported API collection