Skip to content

Commit eed77a6

Browse files
README: added JAX-RS and Spring
1 parent 775ca4c commit eed77a6

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -188,6 +188,29 @@ Output is configured using several parameters:
188188
For more details see [Modules and Namespaces](http://vojtechhabarta.github.io/typescript-generator/doc/ModulesAndNamespaces.html) page.
189189

190190

191+
REST frameworks
192+
---------------
193+
Typescript-generator can generate not only TypeScript declarations for JSON Java classes but it can also generate client classes for REST services. Suppported REST frameworks are JAXR-RS and Spring. Client for JAX-RS service can be generated using `generateJaxrsApplicationClient` parameter, client for Spring service can be generated using `generateSpringApplicationClient`. Since Spring support is in separate module it is needed to add this module to typescript-generator dependencies. Here is example for Maven:
194+
``` xml
195+
<plugin>
196+
<groupId>cz.habarta.typescript-generator</groupId>
197+
<artifactId>typescript-generator-maven-plugin</artifactId>
198+
<version>${typescript-generator.version}</version>
199+
<configuration>
200+
<generateSpringApplicationClient>true</generateSpringApplicationClient>
201+
...
202+
</configuration>
203+
<dependencies>
204+
<dependency>
205+
<groupId>cz.habarta.typescript-generator</groupId>
206+
<artifactId>typescript-generator-spring</artifactId>
207+
<version>${typescript-generator.version}</version>
208+
</dependency>
209+
</dependencies>
210+
</plugin>
211+
```
212+
213+
191214
Download
192215
--------
193216
Releases are available from Maven Central Repository.

0 commit comments

Comments
 (0)