loafle/openapi-generator-original
3
0
Fork 1
mirror of https://github.com/OpenAPITools/openapi-generator.git synced 2025-07-03 22:20:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

better docstring for jersey2 client (#6104)

Browse Source
This commit is contained in:
William Cheng 2020-04-29 23:43:21 +08:00 committed by GitHub
parent bc097cfdde
commit 001d9cb36d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
17 changed files with 195 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
modules/openapi-generator/src/main/resources/Java/libraries/jersey2-experimental/AbstractOpenApiSchema.mustache vendored
View File

@ -7,23 +7,48 @@ import java.lang.reflect.Type;
import java.util.Map;
import javax.ws.rs.core.GenericType;
/**
* Abstract class for oneOf,anyOf schemas defined in OpenAPI spec
*/
{{>additionalModelTypeAnnotations}}{{>generatedAnnotation}}
public abstract class AbstractOpenApiSchema {
// store the actual instance of the schema/object
private Object instance;
public final String schemaType;
// schema type (e.g. oneOf, anyOf)
private final String schemaType;
public AbstractOpenApiSchema(String schemaType) {
this.schemaType = schemaType;
}
/***
* Get the list of schemas allowed to be stored in this object
*
* @return an instance of the actual schema/object
*/
public abstract Map<String, GenericType> getSchemas();
/***
* Get the actual instance
*
* @return an instance of the actual schema/object
*/
public Object getActualInstance() {return instance;}
/***
* Set the actual instance
*
* @param instance the actual instance of the schema/object
*/
public void setActualInstance(Object instance) {this.instance = instance;}
/***
* Get the schema type (e.g. anyOf, oneOf)
*
* @return the schema type
*/
public String getSchemaType() {
return schemaType;
}

15
modules/openapi-generator/src/main/resources/Java/libraries/jersey2-experimental/ApiResponse.mustache vendored
View File

@ -44,14 +44,29 @@ public class ApiResponse<T> {
this.data = data;
}
/**
* Get the status code
*
* @return status code
*/
public int getStatusCode() {
return statusCode;
}
/**
* Get the headers
*
* @return map of headers
*/
public Map<String, List<String>> getHeaders() {
return headers;
}
/**
* Get the data
*
* @return data
*/
public T getData() {
return data;
}

5
modules/openapi-generator/src/main/resources/Java/libraries/jersey2-experimental/JSON.mustache vendored
View File

@ -63,5 +63,10 @@ public class JSON implements ContextResolver<ObjectMapper> {
return mapper;
}
/**
* Get the object mapper
*
* @return object mapper
*/
public ObjectMapper getMapper() { return mapper; }
}

30
modules/openapi-generator/src/main/resources/Java/libraries/jersey2-experimental/api.mustache vendored
View File

@ -16,8 +16,8 @@ import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
{{/fullJavaUtil}}
{{/fullJavaUtil}}
{{>generatedAnnotation}}
{{#operations}}
public class {{classname}} {
@ -31,13 +31,24 @@ public class {{classname}} {
this.apiClient = apiClient;
}
/**
* Get the API cilent
*
* @return API client
*/
public ApiClient getApiClient() {
return apiClient;
}
/**
* Set the API cilent
*
* @param apiClient an instance of API client
*/
public void setApiClient(ApiClient apiClient) {
this.apiClient = apiClient;
}
{{#operation}}
{{^vendorExtensions.x-group-parameters}}
/**
@ -170,7 +181,8 @@ public class {{classname}} {
this.{{localVariablePrefix}}{{paramName}} = {{paramName}};
{{/pathParams}}
}
{{#allParams}}{{^isPathParam}}
{{#allParams}}
{{^isPathParam}}
/**
* Set {{paramName}}
@ -181,7 +193,8 @@ public class {{classname}} {
this.{{localVariablePrefix}}{{paramName}} = {{paramName}};
return this;
}
{{/isPathParam}}{{/allParams}}
{{/isPathParam}}
{{/allParams}}
/**
* Execute {{operationId}} request
@ -216,9 +229,12 @@ public class {{classname}} {
{{/responses}}
</table>
{{/responses.0}}
{{#isDeprecated}}* @deprecated{{/isDeprecated}}
{{#isDeprecated}}
* @deprecated{{/isDeprecated}}
*/
{{#isDeprecated}}@Deprecated{{/isDeprecated}}
{{#isDeprecated}}
@Deprecated
{{/isDeprecated}}
public ApiResponse<{{#returnType}}{{{.}}}{{/returnType}}{{^returnType}}Void{{/returnType}}> executeWithHttpInfo() throws ApiException {
return {{operationId}}WithHttpInfo({{#allParams}}{{localVariablePrefix}}{{paramName}}{{#hasMore}}, {{/hasMore}}{{/allParams}});
}
@ -234,7 +250,9 @@ public class {{classname}} {
{{#externalDocs}}* {{description}}
* @see <a href="{{url}}">{{summary}} Documentation</a>{{/externalDocs}}
*/
{{#isDeprecated}}@Deprecated{{/isDeprecated}}
{{#isDeprecated}}
@Deprecated
{{/isDeprecated}}
public API{{operationId}}Request {{operationId}}({{#pathParams}}{{{dataType}}} {{paramName}}{{#hasMore}}, {{/hasMore}}{{/pathParams}}) throws ApiException {
return new API{{operationId}}Request({{#pathParams}}{{paramName}}{{#hasMore}}, {{/hasMore}}{{/pathParams}});
}

3
modules/openapi-generator/src/main/resources/Java/libraries/jersey2-experimental/apiException.mustache vendored
View File

@ -9,6 +9,9 @@ import java.util.Map.Entry;
import java.util.TreeMap;
{{/caseInsensitiveResponseHeaders}}
/**
* API Exception
*/
{{>generatedAnnotation}}
public class ApiException extends{{#useRuntimeException}} RuntimeException {{/useRuntimeException}}{{^useRuntimeException}} Exception {{/useRuntimeException}}{
private int code = 0;

4
modules/openapi-generator/src/main/resources/Java/libraries/jersey2-experimental/oneof_model.mustache vendored
View File

@ -26,10 +26,6 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im
return {{classname}}.schemas;
}
public String getSchemaType() {
return schemaType;
}
@Override
public void setActualInstance(Object instance) {
{{#oneOf}}

1
samples/client/petstore/java/jersey2-experimental/src/main/java/org/openapitools/client/ApiException.java
View File

@ -15,6 +15,7 @@ package org.openapitools.client;
import java.util.List;
import java.util.Map;
/** API Exception */
public class ApiException extends Exception {
private int code = 0;
private Map<String, List<String>> responseHeaders = null;

15
samples/client/petstore/java/jersey2-experimental/src/main/java/org/openapitools/client/ApiResponse.java
View File

@ -44,14 +44,29 @@ public class ApiResponse<T> {
this.data = data;
}
/**
* Get the status code
*
* @return status code
*/
public int getStatusCode() {
return statusCode;
}
/**
* Get the headers
*
* @return map of headers
*/
public Map<String, List<String>> getHeaders() {
return headers;
}
/**
* Get the data
*
* @return data
*/
public T getData() {
return data;
}

5
samples/client/petstore/java/jersey2-experimental/src/main/java/org/openapitools/client/JSON.java
View File

@ -43,6 +43,11 @@ public class JSON implements ContextResolver<ObjectMapper> {
return mapper;
}
/**
* Get the object mapper
*
* @return object mapper
*/
public ObjectMapper getMapper() {
return mapper;
}

11
samples/client/petstore/java/jersey2-experimental/src/main/java/org/openapitools/client/api/AnotherFakeApi.java
View File

@ -23,13 +23,24 @@ public class AnotherFakeApi {
this.apiClient = apiClient;
}
/**
* Get the API cilent
*
* @return API client
*/
public ApiClient getApiClient() {
return apiClient;
}
/**
* Set the API cilent
*
* @param apiClient an instance of API client
*/
public void setApiClient(ApiClient apiClient) {
this.apiClient = apiClient;
}
/**
* To test special tags To test special tags and operation ID starting with number
*

11
samples/client/petstore/java/jersey2-experimental/src/main/java/org/openapitools/client/api/DefaultApi.java
View File

@ -23,13 +23,24 @@ public class DefaultApi {
this.apiClient = apiClient;
}
/**
* Get the API cilent
*
* @return API client
*/
public ApiClient getApiClient() {
return apiClient;
}
/**
* Set the API cilent
*
* @param apiClient an instance of API client
*/
public void setApiClient(ApiClient apiClient) {
this.apiClient = apiClient;
}
/**
* @return InlineResponseDefault
* @throws ApiException if fails to make API call

11
samples/client/petstore/java/jersey2-experimental/src/main/java/org/openapitools/client/api/FakeApi.java
View File

@ -32,13 +32,24 @@ public class FakeApi {
this.apiClient = apiClient;
}
/**
* Get the API cilent
*
* @return API client
*/
public ApiClient getApiClient() {
return apiClient;
}
/**
* Set the API cilent
*
* @param apiClient an instance of API client
*/
public void setApiClient(ApiClient apiClient) {
this.apiClient = apiClient;
}
/**
* Health check endpoint
*

11
samples/client/petstore/java/jersey2-experimental/src/main/java/org/openapitools/client/api/FakeClassnameTags123Api.java
View File

@ -23,13 +23,24 @@ public class FakeClassnameTags123Api {
this.apiClient = apiClient;
}
/**
* Get the API cilent
*
* @return API client
*/
public ApiClient getApiClient() {
return apiClient;
}
/**
* Set the API cilent
*
* @param apiClient an instance of API client
*/
public void setApiClient(ApiClient apiClient) {
this.apiClient = apiClient;
}
/**
* To test class name in snake case To test class name in snake case
*

11
samples/client/petstore/java/jersey2-experimental/src/main/java/org/openapitools/client/api/PetApi.java
View File

@ -25,13 +25,24 @@ public class PetApi {
this.apiClient = apiClient;
}
/**
* Get the API cilent
*
* @return API client
*/
public ApiClient getApiClient() {
return apiClient;
}
/**
* Set the API cilent
*
* @param apiClient an instance of API client
*/
public void setApiClient(ApiClient apiClient) {
this.apiClient = apiClient;
}
/**
* Add a new pet to the store
*

11
samples/client/petstore/java/jersey2-experimental/src/main/java/org/openapitools/client/api/StoreApi.java
View File

@ -23,13 +23,24 @@ public class StoreApi {
this.apiClient = apiClient;
}
/**
* Get the API cilent
*
* @return API client
*/
public ApiClient getApiClient() {
return apiClient;
}
/**
* Set the API cilent
*
* @param apiClient an instance of API client
*/
public void setApiClient(ApiClient apiClient) {
this.apiClient = apiClient;
}
/**
* Delete purchase order by ID For valid response try integer IDs with value &lt; 1000. Anything
* above 1000 or nonintegers will generate API errors

11
samples/client/petstore/java/jersey2-experimental/src/main/java/org/openapitools/client/api/UserApi.java
View File

@ -23,13 +23,24 @@ public class UserApi {
this.apiClient = apiClient;
}
/**
* Get the API cilent
*
* @return API client
*/
public ApiClient getApiClient() {
return apiClient;
}
/**
* Set the API cilent
*
* @param apiClient an instance of API client
*/
public void setApiClient(ApiClient apiClient) {
this.apiClient = apiClient;
}
/**
* Create user This can only be done by the logged in user.
*

25
samples/client/petstore/java/jersey2-experimental/src/main/java/org/openapitools/client/model/AbstractOpenApiSchema.java
View File

@ -15,26 +15,49 @@ package org.openapitools.client.model;
import java.util.Map;
import javax.ws.rs.core.GenericType;
/** Abstract class for oneOf,anyOf schemas defined in OpenAPI spec */
public abstract class AbstractOpenApiSchema {
// store the actual instance of the schema/object
private Object instance;
public final String schemaType;
// schema type (e.g. oneOf, anyOf)
private final String schemaType;
public AbstractOpenApiSchema(String schemaType) {
this.schemaType = schemaType;
}
/**
* * Get the list of schemas allowed to be stored in this object
*
* @return an instance of the actual schema/object
*/
public abstract Map<String, GenericType> getSchemas();
/**
* * Get the actual instance
*
* @return an instance of the actual schema/object
*/
public Object getActualInstance() {
return instance;
}
/**
* * Set the actual instance
*
* @param instance the actual instance of the schema/object
*/
public void setActualInstance(Object instance) {
this.instance = instance;
}
/**
* * Get the schema type (e.g. anyOf, oneOf)
*
* @return the schema type
*/
public String getSchemaType() {
return schemaType;
}