Elgato_dark/ToolJet
1
0
Fork 0
mirror of https://github.com/ToolJet/ToolJet synced 2026-04-21 21:47:17 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 7
ToolJet/docs/versioned_docs/version-2.24.0/data-sources/openapi.md
Shubhendra Singh Chauhan da46eaf136
[docs] git sync - docs v2.24 (#8078) 
* [docs] gitsync

* [docs]git sync

* updates after review

* added flow diagram and use cases

* changes after review

* Update docs/docs/gitsync.md

* note for workspace constants

* Added docs v2.24.0
2023-12-13 16:27:58 +05:30

1.6 KiB
Raw Permalink 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