org.leandreck.endpoints.annotations

Annotation Type TypeScriptTemplatesConfiguration

@Documented
 @Retention(value=SOURCE)
 @Target(value=TYPE)
public @interface TypeScriptTemplatesConfiguration

Allow changing the templates that will be used for code generation, by specifying their location in the classpath and how they should be processed.

See Also:

PrintConfiguration

Field Summary

Fields

Modifier and Type	Fields and Description
static String	DEFAULT_API_MODULE
static String	DEFAULT_ENDPOINT
static String	DEFAULT_ENUMERATION
static String	DEFAULT_INDEX
static String	DEFAULT_INTERFACE
static String	DEFAULT_SUFFIX_DELETE
static String	DEFAULT_SUFFIX_GET
static String	DEFAULT_SUFFIX_HEAD
static String	DEFAULT_SUFFIX_OPTIONS
static String	DEFAULT_SUFFIX_PATCH
static String	DEFAULT_SUFFIX_POST
static String	DEFAULT_SUFFIX_PUT
static String	DEFAULT_SUFFIX_TRACE
static boolean	DEFAULT_USE_SUFFIXES

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	apimodule Template used to generate the Angular API module.
String	endpoint Template used when generating the actual endpoint.
String	enumeration Template that will be used to generate an enum.
String	index Entrypoint for all the the TypeScript generated classes.
String	interfaces Template used when generating a TypeScript interface.
String	suffixDelete Suffix for HTTP-DELETE Methods.
String	suffixGet Suffix for HTTP-GET Methods.
String	suffixHead Suffix for HTTP-HEAD Methods.
String	suffixOptions Suffix for HTTP-OPTIONS Methods.
String	suffixPatch Suffix for HTTP-PATCH Methods.
String	suffixPost Suffix for HTTP-POST Methods.
String	suffixPut Suffix for HTTP-PUT Methods.
String	suffixTrace Suffix for HTTP-TRACE Methods.
boolean	useSuffixes Whether generated Methods should have suffixes or not.

Field Detail

DEFAULT_API_MODULE

public static final String DEFAULT_API_MODULE

DEFAULT_ENUMERATION

public static final String DEFAULT_ENUMERATION

DEFAULT_INDEX

public static final String DEFAULT_INDEX

DEFAULT_INTERFACE

public static final String DEFAULT_INTERFACE

DEFAULT_ENDPOINT

public static final String DEFAULT_ENDPOINT

DEFAULT_USE_SUFFIXES

public static final boolean DEFAULT_USE_SUFFIXES

DEFAULT_SUFFIX_GET

public static final String DEFAULT_SUFFIX_GET

DEFAULT_SUFFIX_HEAD

public static final String DEFAULT_SUFFIX_HEAD

DEFAULT_SUFFIX_DELETE

public static final String DEFAULT_SUFFIX_DELETE

DEFAULT_SUFFIX_OPTIONS

public static final String DEFAULT_SUFFIX_OPTIONS

DEFAULT_SUFFIX_PATCH

public static final String DEFAULT_SUFFIX_PATCH

DEFAULT_SUFFIX_POST

public static final String DEFAULT_SUFFIX_POST

DEFAULT_SUFFIX_PUT

public static final String DEFAULT_SUFFIX_PUT

DEFAULT_SUFFIX_TRACE

public static final String DEFAULT_SUFFIX_TRACE

Element Detail

apimodule

public abstract String apimodule

Template used to generate the Angular API module.

Returns:

By default returns "/org/leandreck/endpoints/templates/typescript/apimodule.ftl"

Default:

"/org/leandreck/endpoints/templates/typescript/apimodule.ftl"

enumeration

public abstract String enumeration

Template that will be used to generate an enum.

Returns:

By default returns "/org/leandreck/endpoints/templates/typescript/enum.ftl"

Default:

"/org/leandreck/endpoints/templates/typescript/enum.ftl"

index

public abstract String index

Entrypoint for all the the TypeScript generated classes.

Returns:

By default returns "/org/leandreck/endpoints/templates/typescript/index.ftl"

Default:

"/org/leandreck/endpoints/templates/typescript/index.ftl"

interfaces

public abstract String interfaces

Template used when generating a TypeScript interface.

Returns:

By default returns "/org/leandreck/endpoints/templates/typescript/interface.ftl"

Default:

"/org/leandreck/endpoints/templates/typescript/interface.ftl"

endpoint

public abstract String endpoint

Template used when generating the actual endpoint.

Returns:

By default returns "/org/leandreck/endpoints/templates/typescript/service.ftl"

Default:

"/org/leandreck/endpoints/templates/typescript/service.ftl"

useSuffixes

public abstract boolean useSuffixes

Whether generated Methods should have suffixes or not.

Returns:

By default returns true

Default:

true

suffixGet

public abstract String suffixGet

Suffix for HTTP-GET Methods.

Returns:

By default returns "Get".

Default:

"Get"

suffixHead

public abstract String suffixHead

Suffix for HTTP-HEAD Methods.

Returns:

By default returns "Head".

Default:

"Head"

suffixDelete

public abstract String suffixDelete

Suffix for HTTP-DELETE Methods.

Returns:

By default returns "Delete".

Default:

"Delete"

suffixOptions

public abstract String suffixOptions

Suffix for HTTP-OPTIONS Methods.

Returns:

By default returns "Options".

Default:

"Options"

suffixPatch

public abstract String suffixPatch

Suffix for HTTP-PATCH Methods.

Returns:

By default returns "Patch".

Default:

"Patch"

suffixPost

public abstract String suffixPost

Suffix for HTTP-POST Methods.

Returns:

By default returns "Post".

Default:

"Post"

suffixPut

public abstract String suffixPut

Suffix for HTTP-PUT Methods.

Returns:

By default returns "Put".

Default:

"Put"

suffixTrace

public abstract String suffixTrace

Suffix for HTTP-TRACE Methods.

Returns:

By default returns "Trace".

Default:

"Trace"