Skip to content

Commit 96da7aa

Browse files
SBNTTSBNTT
authored
--http-user-agent arg support in dart generator (#8508)
* add User-Agent header * set User-Agent header only if httpUserAgent is defined * add User-Agent header in dart-dio generator * update samples
1 parent eecd30c commit 96da7aa

15 files changed

Lines changed: 82 additions & 80 deletions

File tree

‎modules/openapi-generator/src/main/resources/dart-dio/api.mustache‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@ class {{classname}} {
3333
final String _path = '{{{path}}}'{{#pathParams}}.replaceAll('{' r'{{baseName}}' '}', {{{paramName}}}.toString()){{/pathParams}};
3434

3535
final queryParams = <String, dynamic>{};
36-
final headerParams = <String, dynamic>{
36+
final headerParams = <String, dynamic>{ {{#httpUserAgent}}
37+
'User-Agent': '{{{.}}}',{{/httpUserAgent}}
3738
if (headers != null) ...headers,
3839
};
3940
dynamic bodyData;

‎modules/openapi-generator/src/main/resources/dart/api_client.mustache‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ class ApiClient {
2323
_authentications['{{name}}'] = new HttpBasicAuth();{{/isBasic}}{{#isApiKey}}
2424
_authentications['{{name}}'] = new ApiKeyAuth({{#isKeyInHeader}}"header"{{/isKeyInHeader}}{{^isKeyInHeader}}"query"{{/isKeyInHeader}}, "{{keyParamName}}");{{/isApiKey}}{{#isOAuth}}
2525
_authentications['{{name}}'] = new OAuth();{{/isOAuth}}{{/authMethods}}
26+
{{#httpUserAgent}}addDefaultHeader('User-Agent', '{{{.}}}');{{/httpUserAgent}}
2627
}
2728

2829
void addDefaultHeader(String key, String value) {

‎samples/client/petstore/dart-dio/petstore_client_lib/lib/api/pet_api.dart‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ class PetApi {
3737
final String _path = '/pet';
3838

3939
final queryParams = <String, dynamic>{};
40-
final headerParams = <String, dynamic>{
40+
final headerParams = <String, dynamic>{
4141
if (headers != null) ...headers,
4242
};
4343
dynamic bodyData;
@@ -96,7 +96,7 @@ class PetApi {
9696
final String _path = '/pet/{petId}'.replaceAll('{' r'petId' '}', petId.toString());
9797

9898
final queryParams = <String, dynamic>{};
99-
final headerParams = <String, dynamic>{
99+
final headerParams = <String, dynamic>{
100100
if (headers != null) ...headers,
101101
};
102102
dynamic bodyData;
@@ -147,7 +147,7 @@ class PetApi {
147147
final String _path = '/pet/findByStatus';
148148

149149
final queryParams = <String, dynamic>{};
150-
final headerParams = <String, dynamic>{
150+
final headerParams = <String, dynamic>{
151151
if (headers != null) ...headers,
152152
};
153153
dynamic bodyData;
@@ -217,7 +217,7 @@ class PetApi {
217217
final String _path = '/pet/findByTags';
218218

219219
final queryParams = <String, dynamic>{};
220-
final headerParams = <String, dynamic>{
220+
final headerParams = <String, dynamic>{
221221
if (headers != null) ...headers,
222222
};
223223
dynamic bodyData;
@@ -287,7 +287,7 @@ class PetApi {
287287
final String _path = '/pet/{petId}'.replaceAll('{' r'petId' '}', petId.toString());
288288

289289
final queryParams = <String, dynamic>{};
290-
final headerParams = <String, dynamic>{
290+
final headerParams = <String, dynamic>{
291291
if (headers != null) ...headers,
292292
};
293293
dynamic bodyData;
@@ -355,7 +355,7 @@ class PetApi {
355355
final String _path = '/pet';
356356

357357
final queryParams = <String, dynamic>{};
358-
final headerParams = <String, dynamic>{
358+
final headerParams = <String, dynamic>{
359359
if (headers != null) ...headers,
360360
};
361361
dynamic bodyData;
@@ -415,7 +415,7 @@ class PetApi {
415415
final String _path = '/pet/{petId}'.replaceAll('{' r'petId' '}', petId.toString());
416416

417417
final queryParams = <String, dynamic>{};
418-
final headerParams = <String, dynamic>{
418+
final headerParams = <String, dynamic>{
419419
if (headers != null) ...headers,
420420
};
421421
dynamic bodyData;
@@ -475,7 +475,7 @@ class PetApi {
475475
final String _path = '/pet/{petId}/uploadImage'.replaceAll('{' r'petId' '}', petId.toString());
476476

477477
final queryParams = <String, dynamic>{};
478-
final headerParams = <String, dynamic>{
478+
final headerParams = <String, dynamic>{
479479
if (headers != null) ...headers,
480480
};
481481
dynamic bodyData;

‎samples/client/petstore/dart-dio/petstore_client_lib/lib/api/store_api.dart‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ class StoreApi {
3434
final String _path = '/store/order/{orderId}'.replaceAll('{' r'orderId' '}', orderId.toString());
3535

3636
final queryParams = <String, dynamic>{};
37-
final headerParams = <String, dynamic>{
37+
final headerParams = <String, dynamic>{
3838
if (headers != null) ...headers,
3939
};
4040
dynamic bodyData;
@@ -78,7 +78,7 @@ class StoreApi {
7878
final String _path = '/store/inventory';
7979

8080
final queryParams = <String, dynamic>{};
81-
final headerParams = <String, dynamic>{
81+
final headerParams = <String, dynamic>{
8282
if (headers != null) ...headers,
8383
};
8484
dynamic bodyData;
@@ -149,7 +149,7 @@ class StoreApi {
149149
final String _path = '/store/order/{orderId}'.replaceAll('{' r'orderId' '}', orderId.toString());
150150

151151
final queryParams = <String, dynamic>{};
152-
final headerParams = <String, dynamic>{
152+
final headerParams = <String, dynamic>{
153153
if (headers != null) ...headers,
154154
};
155155
dynamic bodyData;
@@ -210,7 +210,7 @@ class StoreApi {
210210
final String _path = '/store/order';
211211

212212
final queryParams = <String, dynamic>{};
213-
final headerParams = <String, dynamic>{
213+
final headerParams = <String, dynamic>{
214214
if (headers != null) ...headers,
215215
};
216216
dynamic bodyData;

‎samples/client/petstore/dart-dio/petstore_client_lib/lib/api/user_api.dart‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ class UserApi {
3434
final String _path = '/user';
3535

3636
final queryParams = <String, dynamic>{};
37-
final headerParams = <String, dynamic>{
37+
final headerParams = <String, dynamic>{
3838
if (headers != null) ...headers,
3939
};
4040
dynamic bodyData;
@@ -84,7 +84,7 @@ class UserApi {
8484
final String _path = '/user/createWithArray';
8585

8686
final queryParams = <String, dynamic>{};
87-
final headerParams = <String, dynamic>{
87+
final headerParams = <String, dynamic>{
8888
if (headers != null) ...headers,
8989
};
9090
dynamic bodyData;
@@ -134,7 +134,7 @@ class UserApi {
134134
final String _path = '/user/createWithList';
135135

136136
final queryParams = <String, dynamic>{};
137-
final headerParams = <String, dynamic>{
137+
final headerParams = <String, dynamic>{
138138
if (headers != null) ...headers,
139139
};
140140
dynamic bodyData;
@@ -184,7 +184,7 @@ class UserApi {
184184
final String _path = '/user/{username}'.replaceAll('{' r'username' '}', username.toString());
185185

186186
final queryParams = <String, dynamic>{};
187-
final headerParams = <String, dynamic>{
187+
final headerParams = <String, dynamic>{
188188
if (headers != null) ...headers,
189189
};
190190
dynamic bodyData;
@@ -229,7 +229,7 @@ class UserApi {
229229
final String _path = '/user/{username}'.replaceAll('{' r'username' '}', username.toString());
230230

231231
final queryParams = <String, dynamic>{};
232-
final headerParams = <String, dynamic>{
232+
final headerParams = <String, dynamic>{
233233
if (headers != null) ...headers,
234234
};
235235
dynamic bodyData;
@@ -291,7 +291,7 @@ class UserApi {
291291
final String _path = '/user/login';
292292

293293
final queryParams = <String, dynamic>{};
294-
final headerParams = <String, dynamic>{
294+
final headerParams = <String, dynamic>{
295295
if (headers != null) ...headers,
296296
};
297297
dynamic bodyData;
@@ -349,7 +349,7 @@ class UserApi {
349349
final String _path = '/user/logout';
350350

351351
final queryParams = <String, dynamic>{};
352-
final headerParams = <String, dynamic>{
352+
final headerParams = <String, dynamic>{
353353
if (headers != null) ...headers,
354354
};
355355
dynamic bodyData;
@@ -395,7 +395,7 @@ class UserApi {
395395
final String _path = '/user/{username}'.replaceAll('{' r'username' '}', username.toString());
396396

397397
final queryParams = <String, dynamic>{};
398-
final headerParams = <String, dynamic>{
398+
final headerParams = <String, dynamic>{
399399
if (headers != null) ...headers,
400400
};
401401
dynamic bodyData;

‎samples/openapi3/client/petstore/dart-dio/petstore_client_lib/lib/api/pet_api.dart‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ class PetApi {
3737
final String _path = '/pet';
3838

3939
final queryParams = <String, dynamic>{};
40-
final headerParams = <String, dynamic>{
40+
final headerParams = <String, dynamic>{
4141
if (headers != null) ...headers,
4242
};
4343
dynamic bodyData;
@@ -112,7 +112,7 @@ class PetApi {
112112
final String _path = '/pet/{petId}'.replaceAll('{' r'petId' '}', petId.toString());
113113

114114
final queryParams = <String, dynamic>{};
115-
final headerParams = <String, dynamic>{
115+
final headerParams = <String, dynamic>{
116116
if (headers != null) ...headers,
117117
};
118118
dynamic bodyData;
@@ -163,7 +163,7 @@ class PetApi {
163163
final String _path = '/pet/findByStatus';
164164

165165
final queryParams = <String, dynamic>{};
166-
final headerParams = <String, dynamic>{
166+
final headerParams = <String, dynamic>{
167167
if (headers != null) ...headers,
168168
};
169169
dynamic bodyData;
@@ -233,7 +233,7 @@ class PetApi {
233233
final String _path = '/pet/findByTags';
234234

235235
final queryParams = <String, dynamic>{};
236-
final headerParams = <String, dynamic>{
236+
final headerParams = <String, dynamic>{
237237
if (headers != null) ...headers,
238238
};
239239
dynamic bodyData;
@@ -303,7 +303,7 @@ class PetApi {
303303
final String _path = '/pet/{petId}'.replaceAll('{' r'petId' '}', petId.toString());
304304

305305
final queryParams = <String, dynamic>{};
306-
final headerParams = <String, dynamic>{
306+
final headerParams = <String, dynamic>{
307307
if (headers != null) ...headers,
308308
};
309309
dynamic bodyData;
@@ -371,7 +371,7 @@ class PetApi {
371371
final String _path = '/pet';
372372

373373
final queryParams = <String, dynamic>{};
374-
final headerParams = <String, dynamic>{
374+
final headerParams = <String, dynamic>{
375375
if (headers != null) ...headers,
376376
};
377377
dynamic bodyData;
@@ -447,7 +447,7 @@ class PetApi {
447447
final String _path = '/pet/{petId}'.replaceAll('{' r'petId' '}', petId.toString());
448448

449449
final queryParams = <String, dynamic>{};
450-
final headerParams = <String, dynamic>{
450+
final headerParams = <String, dynamic>{
451451
if (headers != null) ...headers,
452452
};
453453
dynamic bodyData;
@@ -507,7 +507,7 @@ class PetApi {
507507
final String _path = '/pet/{petId}/uploadImage'.replaceAll('{' r'petId' '}', petId.toString());
508508

509509
final queryParams = <String, dynamic>{};
510-
final headerParams = <String, dynamic>{
510+
final headerParams = <String, dynamic>{
511511
if (headers != null) ...headers,
512512
};
513513
dynamic bodyData;

‎samples/openapi3/client/petstore/dart-dio/petstore_client_lib/lib/api/store_api.dart‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ class StoreApi {
3434
final String _path = '/store/order/{orderId}'.replaceAll('{' r'orderId' '}', orderId.toString());
3535

3636
final queryParams = <String, dynamic>{};
37-
final headerParams = <String, dynamic>{
37+
final headerParams = <String, dynamic>{
3838
if (headers != null) ...headers,
3939
};
4040
dynamic bodyData;
@@ -78,7 +78,7 @@ class StoreApi {
7878
final String _path = '/store/inventory';
7979

8080
final queryParams = <String, dynamic>{};
81-
final headerParams = <String, dynamic>{
81+
final headerParams = <String, dynamic>{
8282
if (headers != null) ...headers,
8383
};
8484
dynamic bodyData;
@@ -149,7 +149,7 @@ class StoreApi {
149149
final String _path = '/store/order/{orderId}'.replaceAll('{' r'orderId' '}', orderId.toString());
150150

151151
final queryParams = <String, dynamic>{};
152-
final headerParams = <String, dynamic>{
152+
final headerParams = <String, dynamic>{
153153
if (headers != null) ...headers,
154154
};
155155
dynamic bodyData;
@@ -210,7 +210,7 @@ class StoreApi {
210210
final String _path = '/store/order';
211211

212212
final queryParams = <String, dynamic>{};
213-
final headerParams = <String, dynamic>{
213+
final headerParams = <String, dynamic>{
214214
if (headers != null) ...headers,
215215
};
216216
dynamic bodyData;

‎samples/openapi3/client/petstore/dart-dio/petstore_client_lib/lib/api/user_api.dart‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ class UserApi {
3434
final String _path = '/user';
3535

3636
final queryParams = <String, dynamic>{};
37-
final headerParams = <String, dynamic>{
37+
final headerParams = <String, dynamic>{
3838
if (headers != null) ...headers,
3939
};
4040
dynamic bodyData;
@@ -93,7 +93,7 @@ class UserApi {
9393
final String _path = '/user/createWithArray';
9494

9595
final queryParams = <String, dynamic>{};
96-
final headerParams = <String, dynamic>{
96+
final headerParams = <String, dynamic>{
9797
if (headers != null) ...headers,
9898
};
9999
dynamic bodyData;
@@ -152,7 +152,7 @@ class UserApi {
152152
final String _path = '/user/createWithList';
153153

154154
final queryParams = <String, dynamic>{};
155-
final headerParams = <String, dynamic>{
155+
final headerParams = <String, dynamic>{
156156
if (headers != null) ...headers,
157157
};
158158
dynamic bodyData;
@@ -211,7 +211,7 @@ class UserApi {
211211
final String _path = '/user/{username}'.replaceAll('{' r'username' '}', username.toString());
212212

213213
final queryParams = <String, dynamic>{};
214-
final headerParams = <String, dynamic>{
214+
final headerParams = <String, dynamic>{
215215
if (headers != null) ...headers,
216216
};
217217
dynamic bodyData;
@@ -263,7 +263,7 @@ class UserApi {
263263
final String _path = '/user/{username}'.replaceAll('{' r'username' '}', username.toString());
264264

265265
final queryParams = <String, dynamic>{};
266-
final headerParams = <String, dynamic>{
266+
final headerParams = <String, dynamic>{
267267
if (headers != null) ...headers,
268268
};
269269
dynamic bodyData;
@@ -325,7 +325,7 @@ class UserApi {
325325
final String _path = '/user/login';
326326

327327
final queryParams = <String, dynamic>{};
328-
final headerParams = <String, dynamic>{
328+
final headerParams = <String, dynamic>{
329329
if (headers != null) ...headers,
330330
};
331331
dynamic bodyData;
@@ -383,7 +383,7 @@ class UserApi {
383383
final String _path = '/user/logout';
384384

385385
final queryParams = <String, dynamic>{};
386-
final headerParams = <String, dynamic>{
386+
final headerParams = <String, dynamic>{
387387
if (headers != null) ...headers,
388388
};
389389
dynamic bodyData;
@@ -436,7 +436,7 @@ class UserApi {
436436
final String _path = '/user/{username}'.replaceAll('{' r'username' '}', username.toString());
437437

438438
final queryParams = <String, dynamic>{};
439-
final headerParams = <String, dynamic>{
439+
final headerParams = <String, dynamic>{
440440
if (headers != null) ...headers,
441441
};
442442
dynamic bodyData;

‎samples/openapi3/client/petstore/dart-dio/petstore_client_lib_fake/lib/api/another_fake_api.dart‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ class AnotherFakeApi {
3333
final String _path = '/another-fake/dummy';
3434

3535
final queryParams = <String, dynamic>{};
36-
final headerParams = <String, dynamic>{
36+
final headerParams = <String, dynamic>{
3737
if (headers != null) ...headers,
3838
};
3939
dynamic bodyData;

‎samples/openapi3/client/petstore/dart-dio/petstore_client_lib_fake/lib/api/default_api.dart‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ class DefaultApi {
3232
final String _path = '/foo';
3333

3434
final queryParams = <String, dynamic>{};
35-
final headerParams = <String, dynamic>{
35+
final headerParams = <String, dynamic>{
3636
if (headers != null) ...headers,
3737
};
3838
dynamic bodyData;

0 commit comments

Comments
 (0)