mirror of
https://github.com/ToolJet/ToolJet
synced 2026-04-22 14:07:26 +00:00
42 lines
1.6 KiB
Markdown
42 lines
1.6 KiB
Markdown
---
|
|
id: openapi
|
|
title: OpenAPI
|
|
---
|
|
|
|
OpenAPI is a specification for designing and documenting RESTful APIs. Using OpenAPI datasource, ToolJet can generate REST API operations from OpenAPI Specs.
|
|
|
|
<div style={{paddingTop:'24px'}}>
|
|
|
|
## Connection
|
|
|
|
To establish a connection with the OpenAPI datasource, you can either click on the **+ Add new Data source** button located on the query panel or navigate to the **[Data sources](/docs/data-sources/overview)** 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](https://swagger.io/docs/specification/authentication/).
|
|
|
|
:::info
|
|
OpenAPI datasource accepts specifications only in **JSON** and **YAML** formats.
|
|
:::
|
|
|
|
<img className="screenshot-full" src="/img/datasource-reference/openapi/openapiconnect-v2.png" alt="OpenAPI" />
|
|
|
|
</div>
|
|
|
|
<div style={{paddingTop:'24px'}}>
|
|
|
|
## Querying OpenAPI
|
|
|
|
1. Click on **+ Add** button of the query manager at the bottom panel of the editor.
|
|
2. Select the **OpenAPI** datasource added in previous step.
|
|
3. Select the desired operation.
|
|
4. Click on the **Preview** button to preview the output or Click on the **Run** button to trigger the query.
|
|
|
|
**Note**: Operations will be automatically generated from the specifications, and each operation will be distinct from others.
|
|
|
|
### Fields
|
|
|
|
- **Host**
|
|
- **Operation**
|
|
|
|
<img className="screenshot-full" src="/img/datasource-reference/openapi/query.png" alt="OpenAPI" />
|
|
|
|
</div>
|