Overview
This node dynamically interacts with any OpenAPI-compliant REST API by fetching the OpenAPI JSON specification from a provided URL. It allows users to select an operation from the API, specify parameters (query, path, header, or body), and execute the operation, returning the API response. This is useful for integrating with APIs without pre-built nodes, enabling flexible API calls based on the OpenAPI spec.
Use Case Examples
- Calling a weather API operation to get current weather by specifying city as a query parameter.
- Interacting with a user management API to create a new user by providing user details in the request body.
- Fetching data from a financial API by selecting an operation and passing required path and query parameters.
Properties
| Name | Meaning |
|---|---|
| OpenAPI JSON URL | URL to the OpenAPI JSON specification describing the API to interact with. |
| Tag Filter | Filter available operations based on OpenAPI tags to narrow down operation choices. |
| Parameters (Form) | Collection of parameters to send with the API request, including name, location (query, path, header, body), and value. |
Output
JSON
json- The JSON response data returned from the executed API operation.
Dependencies
- Requires an API request library (axios) to perform HTTP requests.
Troubleshooting
- Ensure the OpenAPI JSON URL is correct and accessible; errors in fetching the spec will prevent operation loading.
- Verify that required path parameters are provided; missing path parameters will cause errors.
- Check that the operation ID matches one defined in the OpenAPI spec; otherwise, the operation will not be found.
- If authentication is required, ensure credentials (API key or token) are correctly configured and passed in headers.
Links
- OpenAPI Specification - Official specification for OpenAPI used to describe REST APIs.
- Axios HTTP Client - HTTP client library used for making API requests in the node.