fork of hey-api/openapi-ts because I need some additional things
Merge pull request #1769 from hey-api/docs/input-path
docs: update example input paths
+123
-116
+5
-5
README.md
+5
-5
README.md
···
57
57
58
58
```sh
59
59
npx @hey-api/openapi-ts \
60
-
-i path/to/openapi.json \
60
+
-i https://get.heyapi.dev/hey-api/backend \
61
61
-o src/client \
62
62
-c @hey-api/client-fetch
63
63
```
···
114
114
import { createClient } from '@hey-api/openapi-ts';
115
115
116
116
createClient({
117
-
input: 'path/to/openapi.json',
117
+
input: 'https://get.heyapi.dev/hey-api/backend',
118
118
output: 'src/client',
119
119
plugins: ['@hey-api/client-fetch'],
120
120
});
···
130
130
import { defineConfig } from '@hey-api/openapi-ts';
131
131
132
132
export default defineConfig({
133
-
input: 'path/to/openapi.json',
133
+
input: 'https://get.heyapi.dev/hey-api/backend',
134
134
output: 'src/client',
135
135
plugins: ['@hey-api/client-fetch'],
136
136
});
···
141
141
```js
142
142
/** @type {import('@hey-api/openapi-ts').UserConfig} */
143
143
module.exports = {
144
-
input: 'path/to/openapi.json',
144
+
input: 'https://get.heyapi.dev/hey-api/backend',
145
145
output: 'src/client',
146
146
plugins: ['@hey-api/client-fetch'],
147
147
};
···
152
152
```js
153
153
/** @type {import('@hey-api/openapi-ts').UserConfig} */
154
154
export default {
155
-
input: 'path/to/openapi.json',
155
+
input: 'https://get.heyapi.dev/hey-api/backend',
156
156
output: 'src/client',
157
157
plugins: ['@hey-api/client-fetch'],
158
158
};
+8
-1
docs/.vitepress/theme/Layout.vue
+8
-1
docs/.vitepress/theme/Layout.vue
···
9
9
<template #layout-top>
10
10
<div class="announcement">
11
11
<span>
12
+
Our platform<span class="hide-sm"> for OpenAPI specifications</span>
13
+
is now available
14
+
</span>
15
+
<a href="https://app.heyapi.dev/"> Join Beta </a>
16
+
</div>
17
+
<!-- <div class="announcement">
18
+
<span>
12
19
Request a feature<span class="hide-sm"> for your business</span>
13
20
</span>
14
21
<a
···
18
25
>
19
26
Let's Talk
20
27
</a>
21
-
</div>
28
+
</div> -->
22
29
</template>
23
30
</Layout>
24
31
</template>
+1
-1
docs/index.md
+1
-1
docs/index.md
···
3
3
4
4
hero:
5
5
name: High-quality tools for interacting with APIs
6
-
tagline: Codegen for your TypeScript projects. Trusted more than 800k times each month to generate reliable API clients and SDKs.
6
+
tagline: Codegen for your TypeScript projects. Trusted more than 900k times each month to generate reliable API clients and SDKs.
7
7
actions:
8
8
- link: /openapi-ts/get-started
9
9
text: Get Started
+4
-4
docs/openapi-ts/clients/axios.md
+4
-4
docs/openapi-ts/clients/axios.md
···
53
53
54
54
```js [config]
55
55
export default {
56
-
input: 'path/to/openapi.json',
56
+
input: 'https://get.heyapi.dev/hey-api/backend',
57
57
output: 'src/client',
58
58
plugins: ['@hey-api/client-axios'], // [!code ++]
59
59
};
···
61
61
62
62
```sh [cli]
63
63
npx @hey-api/openapi-ts \
64
-
-i path/to/openapi.json \
64
+
-i https://get.heyapi.dev/hey-api/backend \
65
65
-o src/client \
66
66
-c @hey-api/client-axios # [!code ++]
67
67
```
···
94
94
95
95
```js
96
96
export default {
97
-
input: 'path/to/openapi.json',
97
+
input: 'https://get.heyapi.dev/hey-api/backend',
98
98
output: 'src/client',
99
99
plugins: [
100
100
{
···
224
224
225
225
```js
226
226
export default {
227
-
input: 'path/to/openapi.json',
227
+
input: 'https://get.heyapi.dev/hey-api/backend',
228
228
output: 'src/client',
229
229
plugins: [
230
230
{
+4
-4
docs/openapi-ts/clients/fetch.md
+4
-4
docs/openapi-ts/clients/fetch.md
···
53
53
54
54
```js [config]
55
55
export default {
56
-
input: 'path/to/openapi.json',
56
+
input: 'https://get.heyapi.dev/hey-api/backend',
57
57
output: 'src/client',
58
58
plugins: ['@hey-api/client-fetch'], // [!code ++]
59
59
};
···
61
61
62
62
```sh [cli]
63
63
npx @hey-api/openapi-ts \
64
-
-i path/to/openapi.json \
64
+
-i https://get.heyapi.dev/hey-api/backend \
65
65
-o src/client \
66
66
-c @hey-api/client-fetch # [!code ++]
67
67
```
···
94
94
95
95
```js
96
96
export default {
97
-
input: 'path/to/openapi.json',
97
+
input: 'https://get.heyapi.dev/hey-api/backend',
98
98
output: 'src/client',
99
99
plugins: [
100
100
{
···
264
264
265
265
```js
266
266
export default {
267
-
input: 'path/to/openapi.json',
267
+
input: 'https://get.heyapi.dev/hey-api/backend',
268
268
output: 'src/client',
269
269
plugins: [
270
270
{
+5
-5
docs/openapi-ts/clients/legacy.md
+5
-5
docs/openapi-ts/clients/legacy.md
···
19
19
20
20
```js [fetch]
21
21
export default {
22
-
input: 'path/to/openapi.json',
22
+
input: 'https://get.heyapi.dev/hey-api/backend',
23
23
output: 'src/client',
24
24
plugins: ['legacy/fetch'], // [!code ++]
25
25
};
···
27
27
28
28
```js [axios]
29
29
export default {
30
-
input: 'path/to/openapi.json',
30
+
input: 'https://get.heyapi.dev/hey-api/backend',
31
31
output: 'src/client',
32
32
plugins: ['legacy/axios'], // [!code ++]
33
33
};
···
35
35
36
36
```js [angular]
37
37
export default {
38
-
input: 'path/to/openapi.json',
38
+
input: 'https://get.heyapi.dev/hey-api/backend',
39
39
output: 'src/client',
40
40
plugins: ['legacy/angular'], // [!code ++]
41
41
};
···
43
43
44
44
```js [node]
45
45
export default {
46
-
input: 'path/to/openapi.json',
46
+
input: 'https://get.heyapi.dev/hey-api/backend',
47
47
output: 'src/client',
48
48
plugins: ['legacy/node'], // [!code ++]
49
49
};
···
51
51
52
52
```js [xhr]
53
53
export default {
54
-
input: 'path/to/openapi.json',
54
+
input: 'https://get.heyapi.dev/hey-api/backend',
55
55
output: 'src/client',
56
56
plugins: ['legacy/xhr'], // [!code ++]
57
57
};
+4
-4
docs/openapi-ts/clients/next-js.md
+4
-4
docs/openapi-ts/clients/next-js.md
···
47
47
48
48
```js [config]
49
49
export default {
50
-
input: 'path/to/openapi.json',
50
+
input: 'https://get.heyapi.dev/hey-api/backend',
51
51
output: 'src/client',
52
52
plugins: ['@hey-api/client-next'], // [!code ++]
53
53
};
···
55
55
56
56
```sh [cli]
57
57
npx @hey-api/openapi-ts \
58
-
-i path/to/openapi.json \
58
+
-i https://get.heyapi.dev/hey-api/backend \
59
59
-o src/client \
60
60
-c @hey-api/client-next # [!code ++]
61
61
```
···
88
88
89
89
```js
90
90
export default {
91
-
input: 'path/to/openapi.json',
91
+
input: 'https://get.heyapi.dev/hey-api/backend',
92
92
output: 'src/client',
93
93
plugins: [
94
94
{
···
255
255
256
256
```js
257
257
export default {
258
-
input: 'path/to/openapi.json',
258
+
input: 'https://get.heyapi.dev/hey-api/backend',
259
259
output: 'src/client',
260
260
plugins: [
261
261
{
+4
-4
docs/openapi-ts/clients/nuxt.md
+4
-4
docs/openapi-ts/clients/nuxt.md
···
47
47
48
48
```js [config]
49
49
export default {
50
-
input: 'path/to/openapi.json',
50
+
input: 'https://get.heyapi.dev/hey-api/backend',
51
51
output: 'src/client',
52
52
plugins: ['@hey-api/client-nuxt'], // [!code ++]
53
53
};
···
55
55
56
56
```sh [cli]
57
57
npx @hey-api/openapi-ts \
58
-
-i path/to/openapi.json \
58
+
-i https://get.heyapi.dev/hey-api/backend \
59
59
-o src/client \
60
60
-c @hey-api/client-nuxt # [!code ++]
61
61
```
···
88
88
89
89
```js
90
90
export default {
91
-
input: 'path/to/openapi.json',
91
+
input: 'https://get.heyapi.dev/hey-api/backend',
92
92
output: 'src/client',
93
93
plugins: [
94
94
{
···
222
222
223
223
```js
224
224
export default {
225
-
input: 'path/to/openapi.json',
225
+
input: 'https://get.heyapi.dev/hey-api/backend',
226
226
output: 'src/client',
227
227
plugins: [
228
228
{
+15
-15
docs/openapi-ts/configuration.md
+15
-15
docs/openapi-ts/configuration.md
···
13
13
import { defineConfig } from '@hey-api/openapi-ts';
14
14
15
15
export default defineConfig({
16
-
input: 'path/to/openapi.json',
16
+
input: 'https://get.heyapi.dev/hey-api/backend',
17
17
output: 'src/client',
18
18
plugins: ['@hey-api/client-fetch'],
19
19
});
···
22
22
```js [openapi-ts.config.cjs]
23
23
/** @type {import('@hey-api/openapi-ts').UserConfig} */
24
24
module.exports = {
25
-
input: 'path/to/openapi.json',
25
+
input: 'https://get.heyapi.dev/hey-api/backend',
26
26
output: 'src/client',
27
27
plugins: ['@hey-api/client-fetch'],
28
28
};
···
31
31
```js [openapi-ts.config.mjs]
32
32
/** @type {import('@hey-api/openapi-ts').UserConfig} */
33
33
export default {
34
-
input: 'path/to/openapi.json',
34
+
input: 'https://get.heyapi.dev/hey-api/backend',
35
35
output: 'src/client',
36
36
plugins: ['@hey-api/client-fetch'],
37
37
};
···
102
102
103
103
```js [disabled]
104
104
export default {
105
-
input: 'path/to/openapi.json',
105
+
input: 'https://get.heyapi.dev/hey-api/backend',
106
106
output: {
107
107
format: false, // [!code ++]
108
108
path: 'src/client',
···
113
113
114
114
```js [prettier]
115
115
export default {
116
-
input: 'path/to/openapi.json',
116
+
input: 'https://get.heyapi.dev/hey-api/backend',
117
117
output: {
118
118
format: 'prettier', // [!code ++]
119
119
path: 'src/client',
···
124
124
125
125
```js [biome]
126
126
export default {
127
-
input: 'path/to/openapi.json',
127
+
input: 'https://get.heyapi.dev/hey-api/backend',
128
128
output: {
129
129
format: 'biome', // [!code ++]
130
130
path: 'src/client',
···
145
145
146
146
```js [disabled]
147
147
export default {
148
-
input: 'path/to/openapi.json',
148
+
input: 'https://get.heyapi.dev/hey-api/backend',
149
149
output: {
150
150
lint: false, // [!code ++]
151
151
path: 'src/client',
···
156
156
157
157
```js [eslint]
158
158
export default {
159
-
input: 'path/to/openapi.json',
159
+
input: 'https://get.heyapi.dev/hey-api/backend',
160
160
output: {
161
161
lint: 'eslint', // [!code ++]
162
162
path: 'src/client',
···
167
167
168
168
```js [biome]
169
169
export default {
170
-
input: 'path/to/openapi.json',
170
+
input: 'https://get.heyapi.dev/hey-api/backend',
171
171
output: {
172
172
lint: 'biome', // [!code ++]
173
173
path: 'src/client',
···
178
178
179
179
```js [oxlint]
180
180
export default {
181
-
input: 'path/to/openapi.json',
181
+
input: 'https://get.heyapi.dev/hey-api/backend',
182
182
output: {
183
183
lint: 'oxlint', // [!code ++]
184
184
path: 'src/client',
···
202
202
input: {
203
203
// match only the schema named `foo` and `GET` operation for the `/api/v1/foo` path // [!code ++]
204
204
include: '^(#/components/schemas/foo|#/paths/api/v1/foo/get)$', // [!code ++]
205
-
path: 'path/to/openapi.json',
205
+
path: 'https://get.heyapi.dev/hey-api/backend',
206
206
},
207
207
output: 'src/client',
208
208
plugins: ['@hey-api/client-fetch'],
···
214
214
input: {
215
215
// match everything except for the schema named `foo` and `GET` operation for the `/api/v1/foo` path // [!code ++]
216
216
exclude: '^(#/components/schemas/foo|#/paths/api/v1/foo/get)$', // [!code ++]
217
-
path: 'path/to/openapi.json',
217
+
path: 'https://get.heyapi.dev/hey-api/backend',
218
218
},
219
219
output: 'src/client',
220
220
plugins: ['@hey-api/client-fetch'],
···
235
235
236
236
```js [config]
237
237
export default {
238
-
input: 'path/to/openapi.json',
238
+
input: 'https://get.heyapi.dev/hey-api/backend',
239
239
output: 'src/client',
240
240
plugins: ['@hey-api/client-fetch'],
241
241
watch: true, // [!code ++]
···
244
244
245
245
```sh [cli]
246
246
npx @hey-api/openapi-ts \
247
-
-i path/to/openapi.json \
247
+
-i https://get.heyapi.dev/hey-api/backend \
248
248
-o src/client \
249
249
-c @hey-api/client-fetch \
250
250
-w # [!code ++]
···
258
258
259
259
```js
260
260
export default {
261
-
input: 'path/to/openapi.json',
261
+
input: 'https://get.heyapi.dev/hey-api/backend',
262
262
output: {
263
263
clean: false, // [!code ++]
264
264
path: 'src/client',
+1
-1
docs/openapi-ts/custom-plugin.md
+1
-1
docs/openapi-ts/custom-plugin.md
+3
-3
docs/openapi-ts/get-started.md
+3
-3
docs/openapi-ts/get-started.md
···
13
13
This package is in initial development. The interface might change before it becomes stable. We encourage you to leave feedback on [GitHub](https://github.com/hey-api/openapi-ts/issues).
14
14
:::
15
15
16
-
[@hey-api/openapi-ts](https://github.com/hey-api/openapi-ts) is an OpenAPI to TypeScript codegen trusted more than 800k times each month to generate reliable API clients and SDKs. The code is [MIT-licensed](/license) and free to use. Discover available features below or view our [roadmap](https://github.com/orgs/hey-api/discussions/1495) to learn what's coming next.
16
+
[@hey-api/openapi-ts](https://github.com/hey-api/openapi-ts) is an OpenAPI to TypeScript codegen trusted more than 900k times each month to generate reliable API clients and SDKs. The code is [MIT-licensed](/license) and free to use. Discover available features below or view our [roadmap](https://github.com/orgs/hey-api/discussions/1495) to learn what's coming next.
17
17
18
18
### Demo
19
19
···
36
36
37
37
```sh
38
38
npx @hey-api/openapi-ts \
39
-
-i path/to/openapi.json \
39
+
-i https://get.heyapi.dev/hey-api/backend \
40
40
-o src/client \
41
41
-c @hey-api/client-fetch
42
42
```
···
91
91
import { createClient } from '@hey-api/openapi-ts';
92
92
93
93
createClient({
94
-
input: 'path/to/openapi.json',
94
+
input: 'https://get.heyapi.dev/hey-api/backend',
95
95
output: 'src/client',
96
96
plugins: ['@hey-api/client-fetch'],
97
97
});
+39
-39
docs/openapi-ts/migrating.md
+39
-39
docs/openapi-ts/migrating.md
···
44
44
45
45
```js
46
46
export default {
47
-
input: 'path/to/openapi.json',
47
+
input: 'https://get.heyapi.dev/hey-api/backend',
48
48
output: 'src/client',
49
49
plugins: [
50
50
{
···
64
64
```js
65
65
export default {
66
66
client: '@hey-api/client-fetch', // [!code --]
67
-
input: 'path/to/openapi.json',
67
+
input: 'https://get.heyapi.dev/hey-api/backend',
68
68
output: 'src/client',
69
69
plugins: ['@hey-api/client-fetch'], // [!code ++]
70
70
};
···
85
85
86
86
```js
87
87
export default {
88
-
input: 'path/to/openapi.json',
88
+
input: 'https://get.heyapi.dev/hey-api/backend',
89
89
output: 'src/client',
90
90
plugins: [
91
91
{
···
110
110
export default {
111
111
client: '@hey-api/client-fetch',
112
112
experimentalParser: false, // [!code ++]
113
-
input: 'path/to/openapi.json',
113
+
input: 'https://get.heyapi.dev/hey-api/backend',
114
114
output: 'src/client',
115
115
};
116
116
```
···
154
154
155
155
export default {
156
156
client: '@hey-api/client-fetch',
157
-
input: 'path/to/openapi.json',
157
+
input: 'https://get.heyapi.dev/hey-api/backend',
158
158
output: 'src/client',
159
159
plugins: [
160
160
...defaultPlugins,
···
180
180
export default {
181
181
client: '@hey-api/client-fetch',
182
182
debug: true, // [!code --]
183
-
input: 'path/to/openapi.json',
183
+
input: 'https://get.heyapi.dev/hey-api/backend',
184
184
logs: {
185
185
level: 'debug', // [!code ++]
186
186
},
···
198
198
export default {
199
199
client: '@hey-api/client-fetch',
200
200
experimentalParser: true,
201
-
input: 'path/to/openapi.json',
201
+
input: 'https://get.heyapi.dev/hey-api/backend',
202
202
output: 'src/client',
203
203
plugins: [
204
204
...defaultPlugins,
···
234
234
```js
235
235
export default {
236
236
client: '@hey-api/client-fetch',
237
-
input: 'path/to/openapi.json',
237
+
input: 'https://get.heyapi.dev/hey-api/backend',
238
238
output: {
239
239
clean: false, // [!code ++]
240
240
path: 'src/client',
···
250
250
export default {
251
251
client: '@hey-api/client-fetch',
252
252
experimentalParser: true,
253
-
input: 'path/to/openapi.json',
253
+
input: 'https://get.heyapi.dev/hey-api/backend',
254
254
output: 'src/client',
255
255
plugins: [
256
256
// ...other plugins
···
291
291
export default {
292
292
client: '@hey-api/client-fetch',
293
293
experimentalParser: true,
294
-
input: 'path/to/openapi.json',
294
+
input: 'https://get.heyapi.dev/hey-api/backend',
295
295
output: 'src/client',
296
296
plugins: [
297
297
// ...other plugins
···
333
333
experimentalParser: true,
334
334
input: {
335
335
include: '^(#/components/schemas/foo|#/paths/api/v1/foo/get)$', // [!code ++]
336
-
path: 'path/to/openapi.json',
336
+
path: 'https://get.heyapi.dev/hey-api/backend',
337
337
},
338
338
output: 'src/client',
339
339
};
···
358
358
```js [shorthand]
359
359
export default {
360
360
client: '@hey-api/client-fetch',
361
-
input: 'path/to/openapi.json',
361
+
input: 'https://get.heyapi.dev/hey-api/backend',
362
362
output: 'src/client',
363
363
schemas: false, // [!code --]
364
364
plugins: ['@hey-api/types', '@hey-api/services'], // [!code ++]
···
368
368
```js [*.export]
369
369
export default {
370
370
client: '@hey-api/client-fetch',
371
-
input: 'path/to/openapi.json',
371
+
input: 'https://get.heyapi.dev/hey-api/backend',
372
372
output: 'src/client',
373
373
schemas: {
374
374
export: false, // [!code --]
···
386
386
```js
387
387
export default {
388
388
client: '@hey-api/client-fetch',
389
-
input: 'path/to/openapi.json',
389
+
input: 'https://get.heyapi.dev/hey-api/backend',
390
390
output: 'src/client',
391
391
schemas: {
392
392
name: (name) => `${name}Schema`, // [!code --]
···
408
408
```js
409
409
export default {
410
410
client: '@hey-api/client-fetch',
411
-
input: 'path/to/openapi.json',
411
+
input: 'https://get.heyapi.dev/hey-api/backend',
412
412
output: 'src/client',
413
413
services: '^MySchema', // [!code --]
414
414
plugins: [
···
428
428
```js
429
429
export default {
430
430
client: '@hey-api/client-fetch',
431
-
input: 'path/to/openapi.json',
431
+
input: 'https://get.heyapi.dev/hey-api/backend',
432
432
output: 'src/client',
433
433
services: {
434
434
name: '{{name}}Service', // [!code --]
···
450
450
```js
451
451
export default {
452
452
client: '@hey-api/client-fetch',
453
-
input: 'path/to/openapi.json',
453
+
input: 'https://get.heyapi.dev/hey-api/backend',
454
454
output: 'src/client',
455
455
types: {
456
456
dates: 'types+transform', // [!code --]
···
472
472
```js
473
473
export default {
474
474
client: '@hey-api/client-fetch',
475
-
input: 'path/to/openapi.json',
475
+
input: 'https://get.heyapi.dev/hey-api/backend',
476
476
output: 'src/client',
477
477
types: '^MySchema', // [!code --]
478
478
plugins: [
···
492
492
```js
493
493
export default {
494
494
client: '@hey-api/client-fetch',
495
-
input: 'path/to/openapi.json',
495
+
input: 'https://get.heyapi.dev/hey-api/backend',
496
496
output: 'src/client',
497
497
types: {
498
498
name: 'PascalCase', // [!code --]
···
515
515
516
516
```js
517
517
export default {
518
-
input: 'path/to/openapi.json',
518
+
input: 'https://get.heyapi.dev/hey-api/backend',
519
519
output: 'src/client',
520
520
schemas: {
521
521
name: (name) => `$${name}`, // [!code ++]
···
533
533
export default {
534
534
client: 'fetch', // [!code --]
535
535
client: 'legacy/fetch', // [!code ++]
536
-
input: 'path/to/openapi.json',
536
+
input: 'https://get.heyapi.dev/hey-api/backend',
537
537
output: 'src/client',
538
538
};
539
539
```
···
542
542
export default {
543
543
client: 'axios', // [!code --]
544
544
client: 'legacy/axios', // [!code ++]
545
-
input: 'path/to/openapi.json',
545
+
input: 'https://get.heyapi.dev/hey-api/backend',
546
546
output: 'src/client',
547
547
};
548
548
```
···
551
551
export default {
552
552
client: 'angular', // [!code --]
553
553
client: 'legacy/angular', // [!code ++]
554
-
input: 'path/to/openapi.json',
554
+
input: 'https://get.heyapi.dev/hey-api/backend',
555
555
output: 'src/client',
556
556
};
557
557
```
···
560
560
export default {
561
561
client: 'node', // [!code --]
562
562
client: 'legacy/node', // [!code ++]
563
-
input: 'path/to/openapi.json',
563
+
input: 'https://get.heyapi.dev/hey-api/backend',
564
564
output: 'src/client',
565
565
};
566
566
```
···
569
569
export default {
570
570
client: 'xhr', // [!code --]
571
571
client: 'legacy/xhr', // [!code ++]
572
-
input: 'path/to/openapi.json',
572
+
input: 'https://get.heyapi.dev/hey-api/backend',
573
573
output: 'src/client',
574
574
};
575
575
```
···
615
615
```js
616
616
export default {
617
617
client: 'fetch', // [!code ++]
618
-
input: 'path/to/openapi.json',
618
+
input: 'https://get.heyapi.dev/hey-api/backend',
619
619
output: 'src/client',
620
620
};
621
621
```
···
630
630
import { createClient } from '@hey-api/openapi-ts';
631
631
632
632
createClient({
633
-
input: 'path/to/openapi.json',
633
+
input: 'https://get.heyapi.dev/hey-api/backend',
634
634
output: 'src/client',
635
635
services: {
636
636
methodNameBuilder: (service, name) => name, // [!code --]
···
665
665
666
666
```js
667
667
export default {
668
-
input: 'path/to/openapi.json',
668
+
input: 'https://get.heyapi.dev/hey-api/backend',
669
669
output: 'src/client',
670
670
services: {
671
671
asClass: true, // [!code ++]
···
682
682
```js
683
683
export default {
684
684
client: 'axios', // [!code ++]
685
-
input: 'path/to/openapi.json',
685
+
input: 'https://get.heyapi.dev/hey-api/backend',
686
686
output: 'src/client',
687
687
};
688
688
```
···
696
696
```js
697
697
export default {
698
698
format: 'prettier', // [!code --]
699
-
input: 'path/to/openapi.json',
699
+
input: 'https://get.heyapi.dev/hey-api/backend',
700
700
output: {
701
701
format: 'prettier', // [!code ++]
702
702
path: 'src/client',
···
710
710
711
711
```js
712
712
export default {
713
-
input: 'path/to/openapi.json',
713
+
input: 'https://get.heyapi.dev/hey-api/backend',
714
714
lint: 'eslint', // [!code --]
715
715
output: {
716
716
lint: 'eslint', // [!code ++]
···
757
757
```js
758
758
export default {
759
759
enums: 'javascript', // [!code --]
760
-
input: 'path/to/openapi.json',
760
+
input: 'https://get.heyapi.dev/hey-api/backend',
761
761
output: 'src/client',
762
762
types: {
763
763
enums: 'javascript', // [!code ++]
···
774
774
```js{2}
775
775
export default {
776
776
format: 'prettier',
777
-
input: 'path/to/openapi.json',
777
+
input: 'https://get.heyapi.dev/hey-api/backend',
778
778
output: 'src/client',
779
779
}
780
780
```
···
785
785
786
786
```js{3}
787
787
export default {
788
-
input: 'path/to/openapi.json',
788
+
input: 'https://get.heyapi.dev/hey-api/backend',
789
789
lint: 'eslint',
790
790
output: 'src/client',
791
791
}
···
797
797
798
798
```js{5}
799
799
export default {
800
-
input: 'path/to/openapi.json',
800
+
input: 'https://get.heyapi.dev/hey-api/backend',
801
801
output: 'src/client',
802
802
services: {
803
803
operationId: true,
···
813
813
814
814
```js{5}
815
815
export default {
816
-
input: 'path/to/openapi.json',
816
+
input: 'https://get.heyapi.dev/hey-api/backend',
817
817
output: 'src/client',
818
818
services: {
819
819
name: 'myAwesome{{name}}Api',
···
827
827
828
828
```js{5}
829
829
export default {
830
-
input: 'path/to/openapi.json',
830
+
input: 'https://get.heyapi.dev/hey-api/backend',
831
831
output: 'src/client',
832
832
services: {
833
833
response: 'body',
···
841
841
842
842
```js{5}
843
843
export default {
844
-
input: 'path/to/openapi.json',
844
+
input: 'https://get.heyapi.dev/hey-api/backend',
845
845
output: 'src/client',
846
846
type: {
847
847
dates: true,
···
870
870
871
871
```js{5}
872
872
export default {
873
-
input: 'path/to/openapi.json',
873
+
input: 'https://get.heyapi.dev/hey-api/backend',
874
874
output: 'src/client',
875
875
types: {
876
876
name: 'PascalCase',
+2
-2
docs/openapi-ts/output.md
+2
-2
docs/openapi-ts/output.md
···
61
61
import { defaultPlugins } from '@hey-api/openapi-ts';
62
62
63
63
export default {
64
-
input: 'path/to/openapi.json',
64
+
input: 'https://get.heyapi.dev/hey-api/backend',
65
65
output: {
66
66
indexFile: false, // [!code ++]
67
67
path: 'src/client',
···
78
78
import { defaultPlugins } from '@hey-api/openapi-ts';
79
79
80
80
export default {
81
-
input: 'path/to/openapi.json',
81
+
input: 'https://get.heyapi.dev/hey-api/backend',
82
82
output: 'src/client',
83
83
plugins: [
84
84
...defaultPlugins,
+3
-3
docs/openapi-ts/output/json-schema.md
+3
-3
docs/openapi-ts/output/json-schema.md
···
17
17
import { defaultPlugins } from '@hey-api/openapi-ts';
18
18
19
19
export default {
20
-
input: 'path/to/openapi.json',
20
+
input: 'https://get.heyapi.dev/hey-api/backend',
21
21
output: 'src/client',
22
22
plugins: [
23
23
...defaultPlugins,
···
34
34
import { defaultPlugins } from '@hey-api/openapi-ts';
35
35
36
36
export default {
37
-
input: 'path/to/openapi.json',
37
+
input: 'https://get.heyapi.dev/hey-api/backend',
38
38
output: 'src/client',
39
39
plugins: [
40
40
...defaultPlugins,
···
51
51
import { defaultPlugins } from '@hey-api/openapi-ts';
52
52
53
53
export default {
54
-
input: 'path/to/openapi.json',
54
+
input: 'https://get.heyapi.dev/hey-api/backend',
55
55
output: 'src/client',
56
56
plugins: [
57
57
...defaultPlugins,
+3
-3
docs/openapi-ts/output/sdk.md
+3
-3
docs/openapi-ts/output/sdk.md
···
29
29
import { defaultPlugins } from '@hey-api/openapi-ts';
30
30
31
31
export default {
32
-
input: 'path/to/openapi.json',
32
+
input: 'https://get.heyapi.dev/hey-api/backend',
33
33
output: 'src/client',
34
34
plugins: [
35
35
...defaultPlugins,
···
46
46
import { defaultPlugins } from '@hey-api/openapi-ts';
47
47
48
48
export default {
49
-
input: 'path/to/openapi.json',
49
+
input: 'https://get.heyapi.dev/hey-api/backend',
50
50
output: 'src/client',
51
51
plugins: [
52
52
...defaultPlugins,
···
61
61
62
62
```js [none]
63
63
export default {
64
-
input: 'path/to/openapi.json',
64
+
input: 'https://get.heyapi.dev/hey-api/backend',
65
65
output: 'src/client',
66
66
plugins: [
67
67
'@hey-api/client-fetch',
+4
-4
docs/openapi-ts/output/typescript.md
+4
-4
docs/openapi-ts/output/typescript.md
···
42
42
import { defaultPlugins } from '@hey-api/openapi-ts';
43
43
44
44
export default {
45
-
input: 'path/to/openapi.json',
45
+
input: 'https://get.heyapi.dev/hey-api/backend',
46
46
output: 'src/client',
47
47
plugins: [
48
48
...defaultPlugins,
···
65
65
import { defaultPlugins } from '@hey-api/openapi-ts';
66
66
67
67
export default {
68
-
input: 'path/to/openapi.json',
68
+
input: 'https://get.heyapi.dev/hey-api/backend',
69
69
output: 'src/client',
70
70
plugins: [
71
71
...defaultPlugins,
···
82
82
import { defaultPlugins } from '@hey-api/openapi-ts';
83
83
84
84
export default {
85
-
input: 'path/to/openapi.json',
85
+
input: 'https://get.heyapi.dev/hey-api/backend',
86
86
output: 'src/client',
87
87
plugins: [
88
88
...defaultPlugins,
···
99
99
import { defaultPlugins } from '@hey-api/openapi-ts';
100
100
101
101
export default {
102
-
input: 'path/to/openapi.json',
102
+
input: 'https://get.heyapi.dev/hey-api/backend',
103
103
output: 'src/client',
104
104
plugins: [
105
105
...defaultPlugins,
+1
-1
docs/openapi-ts/plugins/fastify.md
+1
-1
docs/openapi-ts/plugins/fastify.md
+5
-5
docs/openapi-ts/plugins/tanstack-query.md
+5
-5
docs/openapi-ts/plugins/tanstack-query.md
···
40
40
import { defaultPlugins } from '@hey-api/openapi-ts';
41
41
42
42
export default {
43
-
input: 'path/to/openapi.json',
43
+
input: 'https://get.heyapi.dev/hey-api/backend',
44
44
output: 'src/client',
45
45
plugins: [
46
46
...defaultPlugins,
···
54
54
import { defaultPlugins } from '@hey-api/openapi-ts';
55
55
56
56
export default {
57
-
input: 'path/to/openapi.json',
57
+
input: 'https://get.heyapi.dev/hey-api/backend',
58
58
output: 'src/client',
59
59
plugins: [
60
60
...defaultPlugins,
···
68
68
import { defaultPlugins } from '@hey-api/openapi-ts';
69
69
70
70
export default {
71
-
input: 'path/to/openapi.json',
71
+
input: 'https://get.heyapi.dev/hey-api/backend',
72
72
output: 'src/client',
73
73
plugins: [
74
74
...defaultPlugins,
···
82
82
import { defaultPlugins } from '@hey-api/openapi-ts';
83
83
84
84
export default {
85
-
input: 'path/to/openapi.json',
85
+
input: 'https://get.heyapi.dev/hey-api/backend',
86
86
output: 'src/client',
87
87
plugins: [
88
88
...defaultPlugins,
···
96
96
import { defaultPlugins } from '@hey-api/openapi-ts';
97
97
98
98
export default {
99
-
input: 'path/to/openapi.json',
99
+
input: 'https://get.heyapi.dev/hey-api/backend',
100
100
output: 'src/client',
101
101
plugins: [
102
102
...defaultPlugins,
+2
-2
docs/openapi-ts/plugins/zod.md
+2
-2
docs/openapi-ts/plugins/zod.md
···
32
32
import { defaultPlugins } from '@hey-api/openapi-ts';
33
33
34
34
export default {
35
-
input: 'path/to/openapi.json',
35
+
input: 'https://get.heyapi.dev/hey-api/backend',
36
36
output: 'src/client',
37
37
plugins: [
38
38
...defaultPlugins,
···
50
50
import { defaultPlugins } from '@hey-api/openapi-ts';
51
51
52
52
export default {
53
-
input: 'path/to/openapi.json',
53
+
input: 'https://get.heyapi.dev/hey-api/backend',
54
54
output: 'src/client',
55
55
plugins: [
56
56
...defaultPlugins,
+3
-3
docs/openapi-ts/transformers.md
+3
-3
docs/openapi-ts/transformers.md
···
35
35
import { defaultPlugins } from '@hey-api/openapi-ts';
36
36
37
37
export default {
38
-
input: 'path/to/openapi.json',
38
+
input: 'https://get.heyapi.dev/hey-api/backend',
39
39
output: 'src/client',
40
40
plugins: [
41
41
...defaultPlugins,
···
53
53
import { defaultPlugins } from '@hey-api/openapi-ts';
54
54
55
55
export default {
56
-
input: 'path/to/openapi.json',
56
+
input: 'https://get.heyapi.dev/hey-api/backend',
57
57
output: 'src/client',
58
58
plugins: [
59
59
...defaultPlugins,
···
75
75
import { defaultPlugins } from '@hey-api/openapi-ts';
76
76
77
77
export default {
78
-
input: 'path/to/openapi.json',
78
+
input: 'https://get.heyapi.dev/hey-api/backend',
79
79
output: 'src/client',
80
80
plugins: [
81
81
...defaultPlugins,
+2
-2
docs/openapi-ts/validators.md
+2
-2
docs/openapi-ts/validators.md
···
31
31
32
32
```js [sdk]
33
33
export default {
34
-
input: 'path/to/openapi.json',
34
+
input: 'https://get.heyapi.dev/hey-api/backend',
35
35
output: 'src/client',
36
36
plugins: [
37
37
'@hey-api/client-fetch',
···
45
45
46
46
```js [validator]
47
47
export default {
48
-
input: 'path/to/openapi.json',
48
+
input: 'https://get.heyapi.dev/hey-api/backend',
49
49
output: 'src/client',
50
50
plugins: [
51
51
'@hey-api/client-fetch',
+5
-5
packages/openapi-ts/README.md
+5
-5
packages/openapi-ts/README.md
···
57
57
58
58
```sh
59
59
npx @hey-api/openapi-ts \
60
-
-i path/to/openapi.json \
60
+
-i https://get.heyapi.dev/hey-api/backend \
61
61
-o src/client \
62
62
-c @hey-api/client-fetch
63
63
```
···
114
114
import { createClient } from '@hey-api/openapi-ts';
115
115
116
116
createClient({
117
-
input: 'path/to/openapi.json',
117
+
input: 'https://get.heyapi.dev/hey-api/backend',
118
118
output: 'src/client',
119
119
plugins: ['@hey-api/client-fetch'],
120
120
});
···
130
130
import { defineConfig } from '@hey-api/openapi-ts';
131
131
132
132
export default defineConfig({
133
-
input: 'path/to/openapi.json',
133
+
input: 'https://get.heyapi.dev/hey-api/backend',
134
134
output: 'src/client',
135
135
plugins: ['@hey-api/client-fetch'],
136
136
});
···
141
141
```js
142
142
/** @type {import('@hey-api/openapi-ts').UserConfig} */
143
143
module.exports = {
144
-
input: 'path/to/openapi.json',
144
+
input: 'https://get.heyapi.dev/hey-api/backend',
145
145
output: 'src/client',
146
146
plugins: ['@hey-api/client-fetch'],
147
147
};
···
152
152
```js
153
153
/** @type {import('@hey-api/openapi-ts').UserConfig} */
154
154
export default {
155
-
input: 'path/to/openapi.json',
155
+
input: 'https://get.heyapi.dev/hey-api/backend',
156
156
output: 'src/client',
157
157
plugins: ['@hey-api/client-fetch'],
158
158
};