Description
n8n-nodes-openapi-compatible
This is an n8n community node. It lets you use Swagger/OpenAPI capable endpoints in your n8n workflows.
@kphillipsjr1101/n8n-nodes-openapi-compatible is a community node for n8n. It lets you use Swagger/OpenAPI capable endpoints in your n8n workflows. 🚀
n8n is a fair-code licensed workflow automation platform.
Installation
Operations
Credentials
Compatibility
Usage
Resources
Version history
Installation
Follow the installation guide in the n8n community nodes documentation.
Operations
Operations are queried dynamically from the remote Swagger/OpenAPI endpoint. The available operations are determined by the endpoint’s schema.
Credentials
Credentials are ✨ optional ✨ but much cleaner than manually building headers and the like. You can use them to authenticate with the remote endpoint. Only some basic types of authentication are supported at this time. You will need to work around this limitation for authentication like OAuth2.
When you create the credentials, it will ask you for the value of the authentication type you’re using. Fill out the fields where appropriate. If you’re not sure, you don’t have to add a credential here. You can just add the values directly to the headers or query parameters in the node. Just make sure to refer to the documentation of the endpoint you’re using. 📑
!image
Compatibility
This node was tested with the following n8n version:
1.83.2
Usage
Should be relatively self explanatory once you’ve added the node to your flow. Fill out the fields as needed. If you’re not sure what to put in a field, refer to the documentation of the endpoint you’re using. 📑
In some cases a remote endpoint may not provide a baseUrl or you may want to develop and test against a different environment. You can set the baseUrl in the node settings. This will override the baseUrl provided by the remote endpoint.
Once you have filled out the spec URL, on operations you can click the dots and refresh to get a dynamic list of valid API endpoints from the spec.
Once an operation is selected, the Operation Parameters section is populated directly from the OpenAPI spec — no need to refer to the API documentation. Required parameters (path, query, header, and cookie) are shown automatically with their expected types, optional parameters can be added from a dropdown, and enums are presented as selectable options. Top-level request body properties from the spec are exposed as individual (body) fields and are merged into the JSON request body.
If you need to send something the spec doesn’t define (or the spec is incomplete), the Custom Parameters collection still lets you add arbitrary path, query, header, and cookie parameters manually, and the Request Body field accepts raw JSON. Spec-defined and custom parameters are sent together.
I will be adding more features as I have time. Feel free to contribute!
