@zackrobertstech/n8n-openapi-node-builder

Build n8n community node properties from OpenAPI 3 specifications.

This package is a maintained fork of @avantguardllc/n8n-openapi-node (source version 0.2.2, MIT licensed). The original project was created by AvantGuardLLC — Zack Roberts Technology did not create the original project. This fork is maintained by Zack Roberts Technology for use by the Zack Roberts Node Studio generator and the n8n community node packages it produces.

Installation

npm install @zackrobertstech/n8n-openapi-node-builder

Usage

import {
  N8NPropertiesBuilder,
  N8NPropertiesBuilderConfig,
} from '@zackrobertstech/n8n-openapi-node-builder';
import * as doc from './openapi.json';

const config: N8NPropertiesBuilderConfig = {};
const builder = new N8NPropertiesBuilder(doc, config); // OpenAPI document FIRST, config SECOND
const properties = builder.build();

The properties array plugs directly into an n8n declarative node:

export class MyNode implements INodeType {
  description: INodeTypeDescription = {
    // ...
    properties,
  };
}

How it works

• Resources are derived from OpenAPI tags (falling back to the first path segment when an operation has no tags).
• Operations are derived from each path + HTTP method, using operationId / summary for naming.
• Query parameters, request bodies, and headers become n8n fields with routing metadata so the declarative engine performs the HTTP requests — no execute() method needed.

Customization

The builder accepts custom parsers and overrides:

import {
  N8NPropertiesBuilder,
  DefaultOperationParser,
  DefaultResourceParser,
} from '@zackrobertstech/n8n-openapi-node-builder';

const builder = new N8NPropertiesBuilder(doc, {
  operation: new MyOperationParser(),
  resource: new MyResourceParser(),
});
const properties = builder.build({ overrides: [/* ... */] });

See the exported IOperationParser, IResourceParser, and Override types for the full customization surface.

License & attribution

MIT. The original work is Copyright (c) 2024 AvantGuardLLC; modifications are Copyright (c) 2026 Zack Roberts Technology. See LICENSE.