mirror of
https://github.com/OpenAPITools/openapi-generator.git
synced 2025-05-12 20:50:55 +00:00
java rest-assured: fix javadoc in templates (#207)
This commit is contained in:
parent
1f64646dc3
commit
ccd0029667
@ -46,6 +46,8 @@ public class ApiClient {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Use common specification for all operations
|
* Use common specification for all operations
|
||||||
|
* @param supplier supplier
|
||||||
|
* @return configuration
|
||||||
*/
|
*/
|
||||||
public Config reqSpecSupplier(Supplier<RequestSpecBuilder> supplier) {
|
public Config reqSpecSupplier(Supplier<RequestSpecBuilder> supplier) {
|
||||||
this.baseReqSpec = supplier;
|
this.baseReqSpec = supplier;
|
||||||
|
@ -51,8 +51,10 @@ public class {{classname}} {
|
|||||||
{{/operations}}
|
{{/operations}}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Customise request specification
|
* Customise request specification
|
||||||
*/
|
* @param consumer consumer
|
||||||
|
* @return api
|
||||||
|
*/
|
||||||
public {{classname}} reqSpec(Consumer<RequestSpecBuilder> consumer) {
|
public {{classname}} reqSpec(Consumer<RequestSpecBuilder> consumer) {
|
||||||
consumer.accept(reqSpec);
|
consumer.accept(reqSpec);
|
||||||
return this;
|
return this;
|
||||||
@ -68,7 +70,7 @@ public class {{classname}} {
|
|||||||
* @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}}
|
* @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}}
|
||||||
{{/allParams}}
|
{{/allParams}}
|
||||||
{{#returnType}}
|
{{#returnType}}
|
||||||
* return {{{returnType}}}
|
* return {{returnType}}
|
||||||
{{/returnType}}
|
{{/returnType}}
|
||||||
{{#isDeprecated}}
|
{{#isDeprecated}}
|
||||||
* @deprecated
|
* @deprecated
|
||||||
@ -117,6 +119,9 @@ public class {{classname}} {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* {{httpMethod}} {{path}}
|
* {{httpMethod}} {{path}}
|
||||||
|
* @param handler handler
|
||||||
|
* @param <T> type
|
||||||
|
* @return type
|
||||||
*/
|
*/
|
||||||
public <T> T execute(Function<Response, T> handler) {
|
public <T> T execute(Function<Response, T> handler) {
|
||||||
return handler.apply(RestAssured.given().spec(reqSpec.build()).expect().spec(respSpec.build()).when().request({{httpMethod}}, REQ_URI));
|
return handler.apply(RestAssured.given().spec(reqSpec.build()).expect().spec(respSpec.build()).when().request({{httpMethod}}, REQ_URI));
|
||||||
@ -125,7 +130,8 @@ public class {{classname}} {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* {{httpMethod}} {{path}}
|
* {{httpMethod}} {{path}}
|
||||||
* @return {{{returnType}}}
|
* @param handler handler
|
||||||
|
* @return {{returnType}}
|
||||||
*/
|
*/
|
||||||
public {{{returnType}}} executeAs(Function<Response, Response> handler) {
|
public {{{returnType}}} executeAs(Function<Response, Response> handler) {
|
||||||
Type type = new TypeToken<{{{returnType}}}>(){}.getType();
|
Type type = new TypeToken<{{{returnType}}}>(){}.getType();
|
||||||
@ -135,7 +141,8 @@ public class {{classname}} {
|
|||||||
{{#bodyParams}}
|
{{#bodyParams}}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {{paramName}} ({{{dataType}}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}
|
* @param {{paramName}} ({{dataType}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}
|
||||||
|
* @return operation
|
||||||
*/
|
*/
|
||||||
public {{operationIdCamelCase}}Oper body({{{dataType}}} {{paramName}}) {
|
public {{operationIdCamelCase}}Oper body({{{dataType}}} {{paramName}}) {
|
||||||
reqSpec.setBody({{paramName}});
|
reqSpec.setBody({{paramName}});
|
||||||
@ -145,7 +152,8 @@ public class {{classname}} {
|
|||||||
{{#headerParams}}
|
{{#headerParams}}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {{paramName}} ({{{dataType}}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}
|
* @param {{paramName}} ({{dataType}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}
|
||||||
|
* @return operation
|
||||||
*/
|
*/
|
||||||
public {{operationIdCamelCase}}Oper {{paramName}}Header(String {{paramName}}) {
|
public {{operationIdCamelCase}}Oper {{paramName}}Header(String {{paramName}}) {
|
||||||
reqSpec.addHeader("{{baseName}}", {{paramName}});
|
reqSpec.addHeader("{{baseName}}", {{paramName}});
|
||||||
@ -155,7 +163,8 @@ public class {{classname}} {
|
|||||||
{{#pathParams}}
|
{{#pathParams}}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {{paramName}} ({{{dataType}}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}
|
* @param {{paramName}} ({{dataType}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}
|
||||||
|
* @return operation
|
||||||
*/
|
*/
|
||||||
public {{operationIdCamelCase}}Oper {{paramName}}Path(Object {{paramName}}) {
|
public {{operationIdCamelCase}}Oper {{paramName}}Path(Object {{paramName}}) {
|
||||||
reqSpec.addPathParam("{{baseName}}", {{paramName}});
|
reqSpec.addPathParam("{{baseName}}", {{paramName}});
|
||||||
@ -165,7 +174,8 @@ public class {{classname}} {
|
|||||||
{{#queryParams}}
|
{{#queryParams}}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {{paramName}} ({{{dataType}}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}
|
* @param {{paramName}} ({{dataType}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}
|
||||||
|
* @return operation
|
||||||
*/
|
*/
|
||||||
public {{operationIdCamelCase}}Oper {{paramName}}Query(Object... {{paramName}}) {
|
public {{operationIdCamelCase}}Oper {{paramName}}Query(Object... {{paramName}}) {
|
||||||
reqSpec.addQueryParam("{{baseName}}", {{paramName}});
|
reqSpec.addQueryParam("{{baseName}}", {{paramName}});
|
||||||
@ -176,7 +186,8 @@ public class {{classname}} {
|
|||||||
{{^isFile}}
|
{{^isFile}}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {{paramName}} ({{{dataType}}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}
|
* @param {{paramName}} ({{dataType}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}
|
||||||
|
* @return operation
|
||||||
*/
|
*/
|
||||||
public {{operationIdCamelCase}}Oper {{paramName}}Form(Object... {{paramName}}) {
|
public {{operationIdCamelCase}}Oper {{paramName}}Form(Object... {{paramName}}) {
|
||||||
reqSpec.addFormParam("{{baseName}}", {{paramName}});
|
reqSpec.addFormParam("{{baseName}}", {{paramName}});
|
||||||
@ -188,9 +199,10 @@ public class {{classname}} {
|
|||||||
{{#isFile}}
|
{{#isFile}}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* It will assume that the control name is file and the <content-type> is <application/octet-stream>
|
* It will assume that the control name is file and the <content-type> is <application/octet-stream>
|
||||||
* @see #reqSpec for customise
|
* @see #reqSpec for customise
|
||||||
* @param {{paramName}} ({{{dataType}}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}
|
* @param {{paramName}} ({{dataType}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}
|
||||||
|
* @return operation
|
||||||
*/
|
*/
|
||||||
public {{operationIdCamelCase}}Oper {{paramName}}MultiPart({{{dataType}}} {{paramName}}) {
|
public {{operationIdCamelCase}}Oper {{paramName}}MultiPart({{{dataType}}} {{paramName}}) {
|
||||||
reqSpec.addMultiPart({{paramName}});
|
reqSpec.addMultiPart({{paramName}});
|
||||||
@ -201,6 +213,8 @@ public class {{classname}} {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Customise request specification
|
* Customise request specification
|
||||||
|
* @param consumer consumer
|
||||||
|
* @return operation
|
||||||
*/
|
*/
|
||||||
public {{operationIdCamelCase}}Oper reqSpec(Consumer<RequestSpecBuilder> consumer) {
|
public {{operationIdCamelCase}}Oper reqSpec(Consumer<RequestSpecBuilder> consumer) {
|
||||||
consumer.accept(reqSpec);
|
consumer.accept(reqSpec);
|
||||||
@ -209,6 +223,8 @@ public class {{classname}} {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Customise response specification
|
* Customise response specification
|
||||||
|
* @param consumer consumer
|
||||||
|
* @return operation
|
||||||
*/
|
*/
|
||||||
public {{operationIdCamelCase}}Oper respSpec(Consumer<ResponseSpecBuilder> consumer) {
|
public {{operationIdCamelCase}}Oper respSpec(Consumer<ResponseSpecBuilder> consumer) {
|
||||||
consumer.accept(respSpec);
|
consumer.accept(respSpec);
|
||||||
|
Loading…
x
Reference in New Issue
Block a user