Overview

This node dynamically interacts with any OpenAPI-defined API by fetching the OpenAPI JSON specification from a provided URL. It allows users to select an operation from the API and specify parameters (query, path, header, or body) to make the API request. The node constructs the request URL and headers based on the OpenAPI spec and user inputs, executes the HTTP request, and returns the API response data. This is useful for integrating with APIs without pre-built nodes, enabling flexible API calls based on OpenAPI specs.

Use Case Examples

1. Calling a REST API operation defined in an OpenAPI spec by providing the spec URL, selecting the operation, and setting query/path/body parameters.
2. Fetching data from a third-party service by dynamically loading its OpenAPI spec and invoking operations with custom parameters.

Properties

Output

JSON

• json - The JSON response data returned from the API call.

Dependencies

• Requires an HTTP client library to make requests (axios).
• Optionally uses credentials for API authentication (e.g., bearer token or API key).

Troubleshooting

• Ensure the OpenAPI JSON URL is correct and accessible; errors fetching the spec will prevent operation loading.
• Verify that required path parameters are provided; missing path parameters cause errors.
• Check that the operation ID matches one defined in the OpenAPI spec; otherwise, the operation won't be found.
• If authentication is required, ensure credentials are correctly configured and included.
• Timeouts or network errors may occur if the API endpoint is unreachable or slow.

Links

• OpenAPI Specification - Official specification for describing RESTful APIs.
• Axios HTTP Client - HTTP client library used for making API requests in the node.