https://github.com/ivov/nodebuilder

Build n8n nodes from OpenAPI specs and YAML files
https://github.com/ivov/nodebuilder

n8n openapi

Last synced: 2 months ago
JSON representation

Build n8n nodes from OpenAPI specs and YAML files

• Host: GitHub
• URL: https://github.com/ivov/nodebuilder
• Owner: ivov
• License: mit
• Created: 2021-01-26T19:56:34.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2022-02-01T10:27:17.000Z (almost 3 years ago)
• Last Synced: 2024-10-03T12:21:12.080Z (3 months ago)
• Topics: n8n, openapi
• Language: TypeScript
• Homepage:
• Size: 656 KB
• Stars: 59
• Watchers: 5
• Forks: 6
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        


  





  
Nodebuilder




  Build n8n nodes from OpenAPI specs and custom API mappings


  by Iván Ovejero





  Installation •

  Operation •

  Custom Spec Syntax





  

  

  






**Nodebuilder** is a utility to generate n8n node files from

- [OpenAPI specs in JSON and YAML](https://github.com/OAI/OpenAPI-Specification) and

- [custom API mappings in YAML](#yaml).

Developed to automate the node creation process for:

- `*.node.ts`, logic for a regular node,

- `GenericFunctions.ts`, helper functions, and

- `*Description.ts`, parameter descriptions.

## Installation

```sh

$ git clone https://github.com/ivov/nodebuilder.git

$ cd nodebuilder && npm i

```

## Operation

### OpenAPI

1. Place the input file in `src/input/openApi/`

2. Run `npm run generate`

3. Inspect `src/output/`

Notes:

- OpenAPI parsing may fail at undetected edge cases. If your spec cannot be parsed, please open an issue.

- OpenAPI parsing needs to be adjusted to respect n8n's resources-and-operations format. Work in progress.

### YAML

1. Write a YAML file in `src/input/custom/`

2. Run `npm run generate`

3. Inspect `src/output/`

For a full description of how to describe an API in YAML, refer to [this explanation](https://github.com/ivov/nodebuilder/blob/main/docs/yaml-mapping.md).

For a full example of an API description in YAML, refer to [`copper.yaml`](https://github.com/ivov/nodebuilder/blob/main/src/input/custom/copper.yaml).

### Placement

Run `npm run place` to place the output files in:

- an n8n clone dir (located alongside the nodebuilder dir), or

- the default custom nodes dir at `~/.n8n/custom`.

## Pending

**OpenAPI:**

  - Add intermediate step to structure the result.

  - Add support for more content types.

**YAML:**

  - Add support for `multiOptions`

**Generator:**

  - Add resource loaders to the TypeScript generator.

  - Generate `*.credentials.ts`

**Extras:**

  - Implement testing with [`git.js`](https://github.com/steveukx/git-js)

  - Explore integration with [VSCode YAML](https://github.com/redhat-developer/vscode-yaml)

## Author

© 2021 [Iván Ovejero](https://github.com/ivov)

## License

Distributed under the MIT License. See [LICENSE.md](LICENSE.md).