Elgato_dark/ToolJet
1
0
Fork 0
mirror of https://github.com/ToolJet/ToolJet synced 2026-04-22 22:17:55 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8
ToolJet/docs/versioned_docs/version-2.9.0/data-sources/openapi.md
Shubhendra Singh Chauhan e9c7cdf57e
[docs] Appbuilder 1.1 (#6874) 
* [docs] conditional action #6304

* [docs] plotly bar mode

* [docs] private app embed var

* [doc] table: selectedCell

* [doc]table nested data

* [doc]number-decimal

* [doc]buttontext

* [doc]boundedbox:default data

* [doc]multi-env updates

* [doc]version 2.9.0

* commented: PR5926

* commented: PR5296 minor change
2023-07-05 19:30:20 +05:30

1.6 KiB
Raw Blame History

id title
openapi OpenAPI

OpenAPI

OpenAPI is a specification for designing and documenting RESTful APIs. Using OpenAPI datasource, ToolJet can generate REST API operations from OpenAPI Specs.

Connection

To establish a connection with the OpenAPI global datasource, you can either click on the +Add new global datasource button located on the query panel or navigate to the Global Datasources page through the ToolJet dashboard.

  • Connections are created based on OpenAPI specifications.
  • The available authentication methods currently supported are Basic Auth, API Key, Bearer Token, and OAuth 2.0.
  • It is also possible to use specifications that require multiple authentications. Learn more here.

:::info OpenAPI datasource accepts specifications only in JSON and YAML formats. :::

OpenAPI

Querying OpenAPI

  • Operations will be automatically generated from the specifications, and each operation will be distinct from others.

Fields

  • Host (Base URL): Some specifications may have one or multiple base URLs/servers, and certain operations might have separate base URLs. Therefore, you can choose the appropriate URL from the host selection.

  • Operation

OpenAPI