Skip to content

Commit

Permalink
java rest-assured: fix javadoc in templates (#207)
Browse files Browse the repository at this point in the history
  • Loading branch information
@jmini
jmini committed Apr 23, 2018
1 parent 1f64646 commit ccd0029
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 11 deletions.
2 changes: 2 additions & 0 deletions modules/openapi-generator/src/main/resources/Java/libraries/rest-assured/ApiClient.mustache
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ public class ApiClient {
/**
* Use common specification for all operations
* @param supplier supplier
* @return configuration
*/
public Config reqSpecSupplier(Supplier<RequestSpecBuilder> supplier) {
this.baseReqSpec = supplier;
Expand Down
38 changes: 27 additions & 11 deletions modules/openapi-generator/src/main/resources/Java/libraries/rest-assured/api.mustache
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,10 @@ public class {{classname}} {
{{/operations}}

/**
* Customise request specification
*/
* Customise request specification
* @param consumer consumer
* @return api
*/
public {{classname}} reqSpec(Consumer<RequestSpecBuilder> consumer) {
consumer.accept(reqSpec);
return this;
Expand All @@ -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}}
{{/allParams}}
{{#returnType}}
* return {{{returnType}}}
* return {{returnType}}
{{/returnType}}
{{#isDeprecated}}
* @deprecated
Expand Down Expand Up @@ -117,6 +119,9 @@ public class {{classname}} {

/**
* {{httpMethod}} {{path}}
* @param handler handler
* @param <T> type
* @return type
*/
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));
Expand All @@ -125,7 +130,8 @@ public class {{classname}} {

/**
* {{httpMethod}} {{path}}
* @return {{{returnType}}}
* @param handler handler
* @return {{returnType}}
*/
public {{{returnType}}} executeAs(Function<Response, Response> handler) {
Type type = new TypeToken<{{{returnType}}}>(){}.getType();
Expand All @@ -135,7 +141,8 @@ public class {{classname}} {
{{#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}}) {
reqSpec.setBody({{paramName}});
Expand All @@ -145,7 +152,8 @@ public class {{classname}} {
{{#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}}) {
reqSpec.addHeader("{{baseName}}", {{paramName}});
Expand All @@ -155,7 +163,8 @@ public class {{classname}} {
{{#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}}) {
reqSpec.addPathParam("{{baseName}}", {{paramName}});
Expand All @@ -165,7 +174,8 @@ public class {{classname}} {
{{#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}}) {
reqSpec.addQueryParam("{{baseName}}", {{paramName}});
Expand All @@ -176,7 +186,8 @@ public class {{classname}} {
{{^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}}) {
reqSpec.addFormParam("{{baseName}}", {{paramName}});
Expand All @@ -188,9 +199,10 @@ public class {{classname}} {
{{#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 &lt;content-type&gt; is &lt;application/octet-stream&gt;
* @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}}) {
reqSpec.addMultiPart({{paramName}});
Expand All @@ -201,6 +213,8 @@ public class {{classname}} {

/**
* Customise request specification
* @param consumer consumer
* @return operation
*/
public {{operationIdCamelCase}}Oper reqSpec(Consumer<RequestSpecBuilder> consumer) {
consumer.accept(reqSpec);
Expand All @@ -209,6 +223,8 @@ public class {{classname}} {

/**
* Customise response specification
* @param consumer consumer
* @return operation
*/
public {{operationIdCamelCase}}Oper respSpec(Consumer<ResponseSpecBuilder> consumer) {
consumer.accept(respSpec);
Expand Down

0 comments on commit ccd0029

Please sign in to comment.