Skip to content

Commit 82156b6

Browse files
viclovskywing328
viclovsky
authored and
wing328
committed
Added constant "httpMethod", "summary" (#697)
1 parent 3085bf1 commit 82156b6

8 files changed

Lines changed: 94 additions & 22 deletions

File tree

‎modules/openapi-generator/src/main/resources/Java/libraries/rest-assured/api.mustache‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ public class {{classname}} {
7070
* @see #{{#isPathParam}}{{paramName}}Path{{/isPathParam}}{{#isQueryParam}}{{paramName}}Query{{/isQueryParam}}{{#isFormParam}}{{^isFile}}{{paramName}}Form{{/isFile}}{{#isFile}}{{paramName}}MultiPart{{/isFile}}{{/isFormParam}}{{#isHeaderParam}}{{paramName}}Header{{/isHeaderParam}}{{#isBodyParam}}body{{/isBodyParam}} {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}
7171
{{/allParams}}
7272
{{#returnType}}
73-
* return {{returnType}}
73+
* return {{{returnType}}}
7474
{{/returnType}}
7575
{{#isDeprecated}}
7676
* @deprecated
@@ -85,7 +85,9 @@ public class {{classname}} {
8585
{{/isDeprecated}}
8686
public class {{operationIdCamelCase}}Oper {
8787
88+
public static final String REQ_METHOD = "{{httpMethod}}";
8889
public static final String REQ_URI = "{{path}}";
90+
public static final String SUMMARY = "{{{summary}}}";
8991
9092
private RequestSpecBuilder reqSpec;
9193
@@ -131,7 +133,7 @@ public class {{classname}} {
131133
/**
132134
* {{httpMethod}} {{path}}
133135
* @param handler handler
134-
* @return {{returnType}}
136+
* @return {{{returnType}}}
135137
*/
136138
public {{{returnType}}} executeAs(Function<Response, Response> handler) {
137139
Type type = new TypeToken<{{{returnType}}}>(){}.getType();
@@ -141,7 +143,7 @@ public class {{classname}} {
141143
{{#bodyParams}}
142144

143145
/**
144-
* @param {{paramName}} ({{dataType}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}
146+
* @param {{paramName}} ({{{dataType}}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}
145147
* @return operation
146148
*/
147149
public {{operationIdCamelCase}}Oper body({{{dataType}}} {{paramName}}) {
@@ -154,7 +156,7 @@ public class {{classname}} {
154156
public static final String {{#convert}}{{paramName}}{{/convert}}_HEADER = "{{baseName}}";
155157

156158
/**
157-
* @param {{paramName}} ({{dataType}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}
159+
* @param {{paramName}} ({{{dataType}}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}
158160
* @return operation
159161
*/
160162
public {{operationIdCamelCase}}Oper {{paramName}}Header(String {{paramName}}) {
@@ -167,7 +169,7 @@ public class {{classname}} {
167169
public static final String {{#convert}}{{paramName}}{{/convert}}_PATH = "{{baseName}}";
168170

169171
/**
170-
* @param {{paramName}} ({{dataType}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}
172+
* @param {{paramName}} ({{{dataType}}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}
171173
* @return operation
172174
*/
173175
public {{operationIdCamelCase}}Oper {{paramName}}Path(Object {{paramName}}) {
@@ -180,7 +182,7 @@ public class {{classname}} {
180182
public static final String {{#convert}}{{paramName}}{{/convert}}_QUERY = "{{baseName}}";
181183

182184
/**
183-
* @param {{paramName}} ({{dataType}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}
185+
* @param {{paramName}} ({{{dataType}}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}
184186
* @return operation
185187
*/
186188
public {{operationIdCamelCase}}Oper {{paramName}}Query(Object... {{paramName}}) {
@@ -194,7 +196,7 @@ public class {{classname}} {
194196
public static final String {{#convert}}{{paramName}}{{/convert}}_FORM = "{{baseName}}";
195197

196198
/**
197-
* @param {{paramName}} ({{dataType}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}
199+
* @param {{paramName}} ({{{dataType}}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}
198200
* @return operation
199201
*/
200202
public {{operationIdCamelCase}}Oper {{paramName}}Form(Object... {{paramName}}) {
@@ -209,7 +211,7 @@ public class {{classname}} {
209211
/**
210212
* It will assume that the control name is file and the &lt;content-type&gt; is &lt;application/octet-stream&gt;
211213
* @see #reqSpec for customise
212-
* @param {{paramName}} ({{dataType}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}
214+
* @param {{paramName}} ({{{dataType}}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}
213215
* @return operation
214216
*/
215217
public {{operationIdCamelCase}}Oper {{paramName}}MultiPart({{{dataType}}} {{paramName}}) {

‎samples/client/petstore/java/rest-assured/src/main/java/org/openapitools/client/api/AnotherFakeApi.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,9 @@ public AnotherFakeApi reqSpec(Consumer<RequestSpecBuilder> consumer) {
7070
*/
7171
public class TestSpecialTagsOper {
7272

73+
public static final String REQ_METHOD = "PATCH";
7374
public static final String REQ_URI = "/another-fake/dummy";
75+
public static final String SUMMARY = "To test special tags";
7476

7577
private RequestSpecBuilder reqSpec;
7678

‎samples/client/petstore/java/rest-assured/src/main/java/org/openapitools/client/api/FakeApi.java‎

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,9 @@ public FakeApi reqSpec(Consumer<RequestSpecBuilder> consumer) {
117117
*/
118118
public class FakeOuterBooleanSerializeOper {
119119

120+
public static final String REQ_METHOD = "POST";
120121
public static final String REQ_URI = "/fake/outer/boolean";
122+
public static final String SUMMARY = "";
121123

122124
private RequestSpecBuilder reqSpec;
123125

@@ -195,7 +197,9 @@ public FakeOuterBooleanSerializeOper respSpec(Consumer<ResponseSpecBuilder> cons
195197
*/
196198
public class FakeOuterCompositeSerializeOper {
197199

200+
public static final String REQ_METHOD = "POST";
198201
public static final String REQ_URI = "/fake/outer/composite";
202+
public static final String SUMMARY = "";
199203

200204
private RequestSpecBuilder reqSpec;
201205

@@ -273,7 +277,9 @@ public FakeOuterCompositeSerializeOper respSpec(Consumer<ResponseSpecBuilder> co
273277
*/
274278
public class FakeOuterNumberSerializeOper {
275279

280+
public static final String REQ_METHOD = "POST";
276281
public static final String REQ_URI = "/fake/outer/number";
282+
public static final String SUMMARY = "";
277283

278284
private RequestSpecBuilder reqSpec;
279285

@@ -351,7 +357,9 @@ public FakeOuterNumberSerializeOper respSpec(Consumer<ResponseSpecBuilder> consu
351357
*/
352358
public class FakeOuterStringSerializeOper {
353359

360+
public static final String REQ_METHOD = "POST";
354361
public static final String REQ_URI = "/fake/outer/string";
362+
public static final String SUMMARY = "";
355363

356364
private RequestSpecBuilder reqSpec;
357365

@@ -428,7 +436,9 @@ public FakeOuterStringSerializeOper respSpec(Consumer<ResponseSpecBuilder> consu
428436
*/
429437
public class TestBodyWithFileSchemaOper {
430438

439+
public static final String REQ_METHOD = "PUT";
431440
public static final String REQ_URI = "/fake/body-with-file-schema";
441+
public static final String SUMMARY = "";
432442

433443
private RequestSpecBuilder reqSpec;
434444

@@ -496,7 +506,9 @@ public TestBodyWithFileSchemaOper respSpec(Consumer<ResponseSpecBuilder> consume
496506
*/
497507
public class TestBodyWithQueryParamsOper {
498508

509+
public static final String REQ_METHOD = "PUT";
499510
public static final String REQ_URI = "/fake/body-with-query-params";
511+
public static final String SUMMARY = "";
500512

501513
private RequestSpecBuilder reqSpec;
502514

@@ -575,7 +587,9 @@ public TestBodyWithQueryParamsOper respSpec(Consumer<ResponseSpecBuilder> consum
575587
*/
576588
public class TestClientModelOper {
577589

590+
public static final String REQ_METHOD = "PATCH";
578591
public static final String REQ_URI = "/fake";
592+
public static final String SUMMARY = "To test \"client\" model";
579593

580594
private RequestSpecBuilder reqSpec;
581595

@@ -665,7 +679,9 @@ public TestClientModelOper respSpec(Consumer<ResponseSpecBuilder> consumer) {
665679
*/
666680
public class TestEndpointParametersOper {
667681

682+
public static final String REQ_METHOD = "POST";
668683
public static final String REQ_URI = "/fake";
684+
public static final String SUMMARY = "Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 ";
669685

670686
private RequestSpecBuilder reqSpec;
671687

@@ -884,7 +900,9 @@ public TestEndpointParametersOper respSpec(Consumer<ResponseSpecBuilder> consume
884900
*/
885901
public class TestEnumParametersOper {
886902

903+
public static final String REQ_METHOD = "GET";
887904
public static final String REQ_URI = "/fake";
905+
public static final String SUMMARY = "To test enum parameters";
888906

889907
private RequestSpecBuilder reqSpec;
890908

@@ -917,7 +935,7 @@ public <T> T execute(Function<Response, T> handler) {
917935
public static final String ENUM_HEADER_STRING_ARRAY_HEADER = "enum_header_string_array";
918936

919937
/**
920-
* @param enumHeaderStringArray (List&lt;String&gt;) Header parameter enum test (string array) (optional)
938+
* @param enumHeaderStringArray (List<String>) Header parameter enum test (string array) (optional)
921939
* @return operation
922940
*/
923941
public TestEnumParametersOper enumHeaderStringArrayHeader(String enumHeaderStringArray) {
@@ -939,7 +957,7 @@ public TestEnumParametersOper enumHeaderStringHeader(String enumHeaderString) {
939957
public static final String ENUM_QUERY_STRING_ARRAY_QUERY = "enum_query_string_array";
940958

941959
/**
942-
* @param enumQueryStringArray (List&lt;String&gt;) Query parameter enum test (string array) (optional)
960+
* @param enumQueryStringArray (List<String>) Query parameter enum test (string array) (optional)
943961
* @return operation
944962
*/
945963
public TestEnumParametersOper enumQueryStringArrayQuery(Object... enumQueryStringArray) {
@@ -983,7 +1001,7 @@ public TestEnumParametersOper enumQueryDoubleQuery(Object... enumQueryDouble) {
9831001
public static final String ENUM_FORM_STRING_ARRAY_FORM = "enum_form_string_array";
9841002

9851003
/**
986-
* @param enumFormStringArray (List&lt;String&gt;) Form parameter enum test (string array) (optional, default to $)
1004+
* @param enumFormStringArray (List<String>) Form parameter enum test (string array) (optional, default to $)
9871005
* @return operation
9881006
*/
9891007
public TestEnumParametersOper enumFormStringArrayForm(Object... enumFormStringArray) {
@@ -1030,7 +1048,9 @@ public TestEnumParametersOper respSpec(Consumer<ResponseSpecBuilder> consumer) {
10301048
*/
10311049
public class TestInlineAdditionalPropertiesOper {
10321050

1051+
public static final String REQ_METHOD = "POST";
10331052
public static final String REQ_URI = "/fake/inline-additionalProperties";
1053+
public static final String SUMMARY = "test inline additionalProperties";
10341054

10351055
private RequestSpecBuilder reqSpec;
10361056

@@ -1061,7 +1081,7 @@ public <T> T execute(Function<Response, T> handler) {
10611081
}
10621082

10631083
/**
1064-
* @param requestBody (Map&lt;String, String&gt;) request body (required)
1084+
* @param requestBody (Map<String, String>) request body (required)
10651085
* @return operation
10661086
*/
10671087
public TestInlineAdditionalPropertiesOper body(Map<String, String> requestBody) {
@@ -1098,7 +1118,9 @@ public TestInlineAdditionalPropertiesOper respSpec(Consumer<ResponseSpecBuilder>
10981118
*/
10991119
public class TestJsonFormDataOper {
11001120

1121+
public static final String REQ_METHOD = "GET";
11011122
public static final String REQ_URI = "/fake/jsonFormData";
1123+
public static final String SUMMARY = "test json serialization of form data";
11021124

11031125
private RequestSpecBuilder reqSpec;
11041126

‎samples/client/petstore/java/rest-assured/src/main/java/org/openapitools/client/api/FakeClassnameTags123Api.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,9 @@ public FakeClassnameTags123Api reqSpec(Consumer<RequestSpecBuilder> consumer) {
7070
*/
7171
public class TestClassnameOper {
7272

73+
public static final String REQ_METHOD = "PATCH";
7374
public static final String REQ_URI = "/fake_classname_test";
75+
public static final String SUMMARY = "To test class name in snake case";
7476

7577
private RequestSpecBuilder reqSpec;
7678

‎samples/client/petstore/java/rest-assured/src/main/java/org/openapitools/client/api/PetApi.java‎

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,9 @@ public PetApi reqSpec(Consumer<RequestSpecBuilder> consumer) {
104104
*/
105105
public class AddPetOper {
106106

107+
public static final String REQ_METHOD = "POST";
107108
public static final String REQ_URI = "/pet";
109+
public static final String SUMMARY = "Add a new pet to the store";
108110

109111
private RequestSpecBuilder reqSpec;
110112

@@ -172,7 +174,9 @@ public AddPetOper respSpec(Consumer<ResponseSpecBuilder> consumer) {
172174
*/
173175
public class DeletePetOper {
174176

177+
public static final String REQ_METHOD = "DELETE";
175178
public static final String REQ_URI = "/pet/{petId}";
179+
public static final String SUMMARY = "Deletes a pet";
176180

177181
private RequestSpecBuilder reqSpec;
178182

@@ -247,11 +251,13 @@ public DeletePetOper respSpec(Consumer<ResponseSpecBuilder> consumer) {
247251
* Multiple status values can be provided with comma separated strings
248252
*
249253
* @see #statusQuery Status values that need to be considered for filter (required)
250-
* return List&lt;Pet&gt;
254+
* return List<Pet>
251255
*/
252256
public class FindPetsByStatusOper {
253257

258+
public static final String REQ_METHOD = "GET";
254259
public static final String REQ_URI = "/pet/findByStatus";
260+
public static final String SUMMARY = "Finds Pets by status";
255261

256262
private RequestSpecBuilder reqSpec;
257263

@@ -282,7 +288,7 @@ public <T> T execute(Function<Response, T> handler) {
282288
/**
283289
* GET /pet/findByStatus
284290
* @param handler handler
285-
* @return List&lt;Pet&gt;
291+
* @return List<Pet>
286292
*/
287293
public List<Pet> executeAs(Function<Response, Response> handler) {
288294
Type type = new TypeToken<List<Pet>>(){}.getType();
@@ -292,7 +298,7 @@ public List<Pet> executeAs(Function<Response, Response> handler) {
292298
public static final String STATUS_QUERY = "status";
293299

294300
/**
295-
* @param status (List&lt;String&gt;) Status values that need to be considered for filter (required)
301+
* @param status (List<String>) Status values that need to be considered for filter (required)
296302
* @return operation
297303
*/
298304
public FindPetsByStatusOper statusQuery(Object... status) {
@@ -325,13 +331,15 @@ public FindPetsByStatusOper respSpec(Consumer<ResponseSpecBuilder> consumer) {
325331
* Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
326332
*
327333
* @see #tagsQuery Tags to filter by (required)
328-
* return List&lt;Pet&gt;
334+
* return List<Pet>
329335
* @deprecated
330336
*/
331337
@Deprecated
332338
public class FindPetsByTagsOper {
333339

340+
public static final String REQ_METHOD = "GET";
334341
public static final String REQ_URI = "/pet/findByTags";
342+
public static final String SUMMARY = "Finds Pets by tags";
335343

336344
private RequestSpecBuilder reqSpec;
337345

@@ -362,7 +370,7 @@ public <T> T execute(Function<Response, T> handler) {
362370
/**
363371
* GET /pet/findByTags
364372
* @param handler handler
365-
* @return List&lt;Pet&gt;
373+
* @return List<Pet>
366374
*/
367375
public List<Pet> executeAs(Function<Response, Response> handler) {
368376
Type type = new TypeToken<List<Pet>>(){}.getType();
@@ -372,7 +380,7 @@ public List<Pet> executeAs(Function<Response, Response> handler) {
372380
public static final String TAGS_QUERY = "tags";
373381

374382
/**
375-
* @param tags (List&lt;String&gt;) Tags to filter by (required)
383+
* @param tags (List<String>) Tags to filter by (required)
376384
* @return operation
377385
*/
378386
public FindPetsByTagsOper tagsQuery(Object... tags) {
@@ -409,7 +417,9 @@ public FindPetsByTagsOper respSpec(Consumer<ResponseSpecBuilder> consumer) {
409417
*/
410418
public class GetPetByIdOper {
411419

420+
public static final String REQ_METHOD = "GET";
412421
public static final String REQ_URI = "/pet/{petId}";
422+
public static final String SUMMARY = "Find pet by ID";
413423

414424
private RequestSpecBuilder reqSpec;
415425

@@ -486,7 +496,9 @@ public GetPetByIdOper respSpec(Consumer<ResponseSpecBuilder> consumer) {
486496
*/
487497
public class UpdatePetOper {
488498

499+
public static final String REQ_METHOD = "PUT";
489500
public static final String REQ_URI = "/pet";
501+
public static final String SUMMARY = "Update an existing pet";
490502

491503
private RequestSpecBuilder reqSpec;
492504

@@ -555,7 +567,9 @@ public UpdatePetOper respSpec(Consumer<ResponseSpecBuilder> consumer) {
555567
*/
556568
public class UpdatePetWithFormOper {
557569

570+
public static final String REQ_METHOD = "POST";
558571
public static final String REQ_URI = "/pet/{petId}";
572+
public static final String SUMMARY = "Updates a pet in the store with form data";
559573

560574
private RequestSpecBuilder reqSpec;
561575

@@ -649,7 +663,9 @@ public UpdatePetWithFormOper respSpec(Consumer<ResponseSpecBuilder> consumer) {
649663
*/
650664
public class UploadFileOper {
651665

666+
public static final String REQ_METHOD = "POST";
652667
public static final String REQ_URI = "/pet/{petId}/uploadImage";
668+
public static final String SUMMARY = "uploads an image";
653669

654670
private RequestSpecBuilder reqSpec;
655671

@@ -753,7 +769,9 @@ public UploadFileOper respSpec(Consumer<ResponseSpecBuilder> consumer) {
753769
*/
754770
public class UploadFileWithRequiredFileOper {
755771

772+
public static final String REQ_METHOD = "POST";
756773
public static final String REQ_URI = "/fake/{petId}/uploadImageWithRequiredFile";
774+
public static final String SUMMARY = "uploads an image (required)";
757775

758776
private RequestSpecBuilder reqSpec;
759777

0 commit comments

Comments
 (0)