Skip to content

Latest commit

 

History

History
 
 

java2typescript-maven-plugin

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 

Purpose

This maven plugin is part of the java2typescript project. It generates a typescript definition of REST services and corresponding DTO model out of JAX-RS annotated Java services.

Goals

There is a single goal generate that generates both .ts and .js files

mvn java2typescript:generate

Parameters

Here are the parameters handled by the plugin

Name Expression Default value Meaning
serviceClass j2ts.serviceClass - Class of REST service
moduleName j2ts.moduleName - Name of output module
tsOutFolder j2ts.tsOutFolder ${project.build.directory} Output folder for ts file
jsOutFolder j2ts.jsOutFolder ${project.build.directory} Output folder for js file

By default the two files will be generated as :

  • <tsOutFolder>/<moduleName>.d.ts
  • <jsOutFolder>/<moduleName>.js

Setup

To use this plugin, you first need to declare a custom repository :

IN PROGRESS

and bind the generate goal to some phase.