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.

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

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.

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

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"