Skip to content

Commit 7b00a64

Browse files
soartec-labsoartec-lab
authored
feat: change httpClient default value from axios to fetch (BREAKING CHANGE) (#2480)
* feat: change `httpClient` default value from `axios` to `fetch` (BREAKING CHANGE) * fix: update definetion in test * chore: remove unnecessary `httpClient` define * docs: update default value in guide * chore: remove unnecessary line break
1 parent d43dd7d commit 7b00a64

File tree

12 files changed

+26
-26
lines changed

12 files changed

+26
-26
lines changed

‎docs/src/pages/guides/fetch-client.mdx‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ id: fetch-client
33
title: Fetch Client
44
---
55

6-
To use the Fetch API as an HTTP client with swr or TanStack Query clients, change the `httpClient` option from `axios` to `fetch`.
6+
The `Fetch API` is the default HTTP client for `swr` and `TanStack Query` clients.
77

88
```js
99
import { defineConfig } from 'orval';
@@ -13,7 +13,6 @@ export default defineConfig({
1313
output: {
1414
...
1515
client: 'swr',
16-
httpClient: 'fetch'
1716
...
1817
},
1918
},
@@ -161,7 +160,6 @@ export default defineConfig({
161160
output: {
162161
...
163162
client: 'swr',
164-
httpClient: 'fetch',
165163
override: {
166164
mutator: {
167165
path: './src/mutator.ts',

‎docs/src/pages/reference/configuration/output.mdx‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Type: `String`.
4949

5050
Valid values: `fetch`, `axios`.
5151

52-
Default Value: `axios`.
52+
Default Value: `fetch`.
5353

5454
```js
5555
import { defineConfig } from 'orval';
@@ -58,13 +58,12 @@ export default defineConfig({
5858
petstore: {
5959
output: {
6060
client: 'swr',
61-
httpClient: 'fetch',
6261
},
6362
},
6463
});
6564
```
6665

67-
Specifying `fetch` as the `httpClient` option will use the Fetch API as the HTTP client instead of Axios.
66+
The Fetch API is used as the default HTTP client. Specify `axios` if you want to use Axios instead.
6867
This property is only valid when `swr`, `react-query`, `vue-query`, and `svelte-query` are specified as the `client` option.
6968

7069
## schemas

‎packages/orval/src/utils/options.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ export const normalizeOptions = async (
185185
workspace: outputOptions.workspace ? outputWorkspace : undefined,
186186
client: outputOptions.client ?? client ?? OutputClient.AXIOS_FUNCTIONS,
187187
httpClient:
188-
outputOptions.httpClient ?? httpClient ?? OutputHttpClient.AXIOS,
188+
outputOptions.httpClient ?? httpClient ?? OutputHttpClient.FETCH,
189189
mode: normalizeOutputMode(outputOptions.mode ?? mode),
190190
mock,
191191
clean: outputOptions.clean ?? clean ?? false,

‎samples/react-app-with-swr/fetch-client/orval.config.ts‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
import { faker } from '@faker-js/faker';
21
import { defineConfig } from 'orval';
32

43
export default defineConfig({
@@ -9,7 +8,6 @@ export default defineConfig({
98
target: 'src/api/endpoints',
109
schemas: 'src/api/models',
1110
client: 'swr',
12-
httpClient: 'fetch',
1311
mock: true,
1412
override: {
1513
fetch: {

‎samples/react-query/custom-fetch/orval.config.ts‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ export default defineConfig({
77
target: 'src/gen/petstore.ts',
88
schemas: 'src/gen/models',
99
client: 'react-query',
10-
httpClient: 'fetch',
1110
baseUrl: 'http://localhost:8000',
1211
mock: true,
1312
prettier: true,

‎samples/svelte-query/custom-fetch/orval.config.ts‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ export default defineConfig({
77
target: 'src/gen/petstore.ts',
88
schemas: 'src/gen/models',
99
client: 'svelte-query',
10-
httpClient: 'fetch',
1110
baseUrl: 'http://localhost:8000',
1211
mock: true,
1312
prettier: true,

‎samples/swr-with-zod/orval.config.ts‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ export default defineConfig({
88
output: {
99
mode: 'tags-split',
1010
client: 'swr',
11-
httpClient: 'fetch',
1211
target: 'src/gen/endpoints',
1312
schemas: 'src/gen/models',
1413
clean: true,

‎samples/vue-query/custom-fetch/orval.config.ts‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ export default defineConfig({
77
target: 'src/gen/petstore.ts',
88
schemas: 'src/gen/models',
99
client: 'vue-query',
10-
httpClient: 'fetch',
1110
baseUrl: 'http://localhost:8000',
1211
mock: true,
1312
prettier: true,

‎tests/configs/react-query.config.ts‎

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,6 @@ export default defineConfig({
105105
schemas: '../generated/react-query/http-client-fetch/model',
106106
mode: 'tags-split',
107107
client: 'react-query',
108-
httpClient: 'fetch',
109108
override: {
110109
fetch: {
111110
forceSuccessResponse: true,
@@ -124,7 +123,6 @@ export default defineConfig({
124123
'../generated/react-query/http-client-fetch-with-include-http-response-return-type/model',
125124
mode: 'tags-split',
126125
client: 'react-query',
127-
httpClient: 'fetch',
128126
override: {
129127
fetch: {
130128
includeHttpResponseReturnType: false,
@@ -140,6 +138,7 @@ export default defineConfig({
140138
target: '../generated/react-query/mutator/endpoints.ts',
141139
schemas: '../generated/react-query/mutator/model',
142140
client: 'react-query',
141+
httpClient: 'axios',
143142
mock: true,
144143
override: {
145144
mutator: {
@@ -166,6 +165,7 @@ export default defineConfig({
166165
target: '../generated/react-query/mutator-client/endpoints.ts',
167166
schemas: '../generated/react-query/mutator-client/model',
168167
client: 'react-query',
168+
httpClient: 'axios',
169169
mock: true,
170170
headers: true,
171171
override: {
@@ -194,7 +194,6 @@ export default defineConfig({
194194
schemas:
195195
'../generated/react-query/http-client-fetch-with-custom-fetch/model',
196196
client: 'react-query',
197-
httpClient: 'fetch',
198197
mock: true,
199198
override: {
200199
mutator: {
@@ -212,6 +211,7 @@ export default defineConfig({
212211
target: '../generated/react-query/mutator-multi-arguments/endpoints.ts',
213212
schemas: '../generated/react-query/mutator-multi-arguments/model',
214213
client: 'react-query',
214+
httpClient: 'axios',
215215
mock: true,
216216
override: {
217217
mutator: {
@@ -237,6 +237,7 @@ export default defineConfig({
237237
target: '../generated/react-query/error-type/endpoints.ts',
238238
schemas: '../generated/react-query/error-type/model',
239239
client: 'react-query',
240+
httpClient: 'axios',
240241
mock: true,
241242
override: {
242243
mutator: {
@@ -262,6 +263,7 @@ export default defineConfig({
262263
target: '../generated/react-query/hook-mutator/endpoints.ts',
263264
schemas: '../generated/react-query/hook-mutator/model',
264265
client: 'react-query',
266+
httpClient: 'axios',
265267
override: {
266268
mutator: {
267269
path: '../mutators/use-custom-instance.ts',
@@ -278,6 +280,7 @@ export default defineConfig({
278280
target: '../generated/react-query/hook-mutator/endpoints.ts',
279281
schemas: '../generated/react-query/hook-mutator/model',
280282
client: 'react-query',
283+
httpClient: 'axios',
281284
override: {
282285
mutator: {
283286
path: '../mutators/use-custom-instance.ts',
@@ -297,6 +300,7 @@ export default defineConfig({
297300
schemas:
298301
'../generated/react-query/hook-mutator-with-second-parameter/model',
299302
client: 'react-query',
303+
httpClient: 'axios',
300304
override: {
301305
mutator: {
302306
path: '../mutators/use-custom-instance-with-second-parameter.ts',
@@ -313,6 +317,7 @@ export default defineConfig({
313317
target: '../generated/react-query/tag-hook-mutator/endpoints.ts',
314318
schemas: '../generated/react-query/tag-hook-mutator/model',
315319
client: 'react-query',
320+
httpClient: 'axios',
316321
override: {
317322
tags: {
318323
pets: {
@@ -333,6 +338,7 @@ export default defineConfig({
333338
target: '../generated/react-query/form-data/endpoints.ts',
334339
schemas: '../generated/react-query/form-data/model',
335340
client: 'react-query',
341+
httpClient: 'axios',
336342
mock: true,
337343
override: {
338344
mutator: {
@@ -350,6 +356,7 @@ export default defineConfig({
350356
target: '../generated/react-query/form-data-with-hook/endpoints.ts',
351357
schemas: '../generated/react-query/form-data-with-hook/model',
352358
client: 'react-query',
359+
httpClient: 'axios',
353360
mock: true,
354361
override: {
355362
mutator: {
@@ -367,6 +374,7 @@ export default defineConfig({
367374
target: '../generated/react-query/form-data-with-mutator/endpoints.ts',
368375
schemas: '../generated/react-query/form-data-with-mutator/model',
369376
client: 'react-query',
377+
httpClient: 'axios',
370378
mock: true,
371379
override: {
372380
mutator: {
@@ -388,6 +396,7 @@ export default defineConfig({
388396
target: '../generated/react-query/form-url-encoded/endpoints.ts',
389397
schemas: '../generated/react-query/form-url-encoded/model',
390398
client: 'react-query',
399+
httpClient: 'axios',
391400
mock: true,
392401
override: {
393402
mutator: {
@@ -405,6 +414,7 @@ export default defineConfig({
405414
target: '../generated/react-query/formUrlEncoded/endpoints.ts',
406415
schemas: '../generated/react-query/formUrlEncoded/model',
407416
client: 'react-query',
417+
httpClient: 'axios',
408418
mock: true,
409419
override: {
410420
mutator: {
@@ -535,6 +545,7 @@ export default defineConfig({
535545
'../generated/react-query/use-prefetch-with-hook-mutator/endpoints.ts',
536546
schemas: '../generated/react-query/use-prefetch-with-hook-mutator/model',
537547
client: 'react-query',
548+
httpClient: 'axios',
538549
override: {
539550
mutator: {
540551
path: '../mutators/use-custom-instance.ts',

‎tests/configs/svelte-query.config.ts‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,6 @@ export default defineConfig({
6464
schemas: '../generated/svelte-query/http-client-fetch/model',
6565
mode: 'tags-split',
6666
client: 'svelte-query',
67-
httpClient: 'fetch',
6867
},
6968
input: {
7069
target: '../specifications/petstore.yaml',
@@ -78,7 +77,6 @@ export default defineConfig({
7877
'../generated/svelte-query/http-client-fetch-with-include-http-response-return-type/model',
7978
mode: 'tags-split',
8079
client: 'svelte-query',
81-
httpClient: 'fetch',
8280
override: {
8381
fetch: {
8482
includeHttpResponseReturnType: false,
@@ -94,6 +92,7 @@ export default defineConfig({
9492
target: '../generated/svelte-query/mutator/endpoints.ts',
9593
schemas: '../generated/svelte-query/mutator/model',
9694
client: 'svelte-query',
95+
httpClient: 'axios',
9796
mock: true,
9897
override: {
9998
mutator: {
@@ -121,7 +120,6 @@ export default defineConfig({
121120
schemas:
122121
'../generated/svelte-query/http-client-fetch-with-custom-fetch/model',
123122
client: 'svelte-query',
124-
httpClient: 'fetch',
125123
mock: true,
126124
override: {
127125
mutator: {

0 commit comments

Comments
 (0)