@@ -7,13 +7,18 @@ Turn Your **OpenAPI** (**Swagger**) spec into a **n8n node**!
77
88<!-- toc -->
99
10- - [ Installation] ( #installation )
11- - [ Usage] ( #usage )
10+ - [ Quick Start] ( #quick-start )
11+ * [ Installation] ( #installation )
12+ * [ Usage] ( #usage )
1213- [ How it works] ( #how-it-works )
13- * [ Request Body] ( #request-body )
14- - [ Customization] ( #customization )
1514 * [ Resource] ( #resource )
1615 * [ Operation] ( #operation )
16+ * [ Query Parameters] ( #query-parameters )
17+ * [ Request Body] ( #request-body )
18+ * [ Headers] ( #headers )
19+ - [ Customization] ( #customization )
20+ * [ Resource] ( #resource-1 )
21+ * [ Operation] ( #operation-1 )
1722 * [ Fields] ( #fields )
1823- [ Use Cases] ( #use-cases )
1924- [ FAQ] ( #faq )
@@ -24,7 +29,9 @@ Turn Your **OpenAPI** (**Swagger**) spec into a **n8n node**!
2429
2530<!-- tocstop -->
2631
27- # Installation
32+ # Quick Start
33+
34+ ## Installation
2835
2936Add ` @devlikeapro/n8n-openapi-node ` as dependency
3037
@@ -36,7 +43,7 @@ pnpm add @devlikeapro/n8n-openapi-node
3643yarn add @devlikeapro/n8n-openapi-node
3744```
3845
39- # Usage
46+ ## Usage
4047
41481 . Add your ` openapi.json ` to ` src/{NodeName} ` folder
4249 (use ** OpenAPI v3** and ** json** , see [ FAQ] ( #faq ) if you don't have it)
@@ -94,6 +101,18 @@ export class Petstore implements INodeType {
941014 . ** Request Body** - a list of ` operation.requestBody.content ` from OpenAPI spec (only for ` application/json ` )
951025 . ** Headers** - a list of ` operation.parameters ` from OpenAPI spec
96103
104+ ## Resource
105+
106+ By default, it get ** Tags** from OpenAPI spec and converts them to ** Resource** in n8n.
107+
108+ ## Operation
109+
110+ By default, it gets ** Operations** from OpenAPI spec and converts them to ** Actions** in n8n.
111+
112+ ## Query Parameters
113+
114+ It gets ` operation.parameters ` from OpenAPI spec and converts them to ** Query Parameters** in n8n.
115+
97116## Request Body
98117
99118It doesn't create the full structure of the request body, only the first level of properties.
@@ -114,6 +133,10 @@ it creates 2 fields in n8n:
114133- ` name ` - with default value ` string `
115134- ` config ` - with default value ` {"id": 0, "name": "string"} `
116135
136+ ## Headers
137+
138+ It gets ` operation.parameters ` from OpenAPI spec and converts them to ** Headers** in n8n.
139+
117140# Customization
118141
119142## Resource
0 commit comments