Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/1000kit/tkit-mp-restclient-plugin
1000kit microprofile rest client generator plugin
https://github.com/1000kit/tkit-mp-restclient-plugin
maven-plugin microprofile quarkus
Last synced: about 2 months ago
JSON representation
1000kit microprofile rest client generator plugin
- Host: GitHub
- URL: https://github.com/1000kit/tkit-mp-restclient-plugin
- Owner: 1000kit
- License: apache-2.0
- Created: 2022-09-14T11:23:20.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-03-20T19:12:09.000Z (almost 2 years ago)
- Last Synced: 2023-07-07T12:05:13.731Z (over 1 year ago)
- Topics: maven-plugin, microprofile, quarkus
- Language: Java
- Homepage: https://github.com/1000kit/tkit-mp-restclient-plugin
- Size: 91.8 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
This plugin is **deprecated** please use [quarkus-openapi-generator](https://github.com/quarkiverse/quarkus-openapi-generator)
# tkit-mp-rest-client-plugin
Tkit microprofile rest client generator plugin
[](https://www.apache.org/licenses/LICENSE-2.0)
[](https://maven-badges.herokuapp.com/maven-central/org.tkit.maven/tkit-mp-restclient-plugin)
[![GitHub Actions Status]()](https://github.com/1000kit/tkit-mp-restclient-plugin/actions/workflows/build.yml)
> Version 0.15.0 new configuration preserveEnumCase. By default false, if set to true:
- Generated enum names are case-sensitive, not forced uppercase anymore
- Common prefix enum name removal is disabled https://github.com/swagger-api/swagger-codegen/issues/5932
> Version 0.14.0 fieldGen LOMBOK_GET_SET for @Getter@/Setter annotation only
> Version 0.12.0+ fix groupByTags feature
> Version 0.9.0+ add support for query params provided as a component ref.
> Version 0.8.0+ add support for `RestController` class and proxy implementation.
> Version 0.7.0+ contains check for generated files. If the generator generated more files with the same
> name the generator throws exception. The combination of the parameters `apiName`, `pathPrefix` or `groupByTags` is use to generate
> corresponding java classes for the openAPI schema.
Example combination
* default configuration generated file for each REST path. `/admin/name`, `/admin` and `/user/name` will generate
two java classes `AdminRestClient` and `UserRestClient`
* if you add only `apiName=User` generator creates one java class `UserRestClient` for all REST method in openAPI schema.
* `apiName=MyRest` and `pathPrefix=/admin` will generated one file `MyRestRestClient` for all REST method which start with `/admin` or `admin` path.
* `apiName=MyRest` and `pathPrefix=/` will generated one file with all REST method. This is equals to setting only the `apiName` parameter.
* if you set the `groupByTags` to `true` the generator will group the REST api by the tags in the openAPI schema. This
is default swagger generator but it could generated wrong java classes; depend on your openAPI schema and the parameter
`apiName` and `pathPrefix` will be ignored.
> Method of the java class are base on the `operationId`. If there are multiple `operationId` methods in the java class the tag
> of the operation is add as prefix to the method. If there are multiple `tag`+ `operationId` methods in the java class
> generator will add suffix `_` to the method.
## Goal: codegen - RestClient
```xml
org.tkit.maven
tkit-mp-restclient-plugin
0.8.0
test
codegen
src/main/resources/clients/openapi.yaml
${project.build.directory}/generated-sources/mprestclient
gen.org.tkit.test
gen.org.tkit.test.models
false
false
LOMBOK
JACKSON
javax.inject.Singleton
org.tkit.quarkus.log.interceptor.LoggerService
org.eclipse.microprofile.rest.client.inject.RegisterRestClient(configKey="my-client-key")
lombok.ToString
io.quarkus.runtime.annotations.RegisterForReflection
test
```
## Goal: codegen - RestController
```xml
org.tkit.maven
tkit-mp-restclient-plugin
0.8.0
user
codegen
src/main/resources/META-INF/openapi.yaml
${project.build.directory}/generated-sources/endpoints
org.tkit.test.rs.internal
org.tkit.test.rs.internal.models
false
false
false
RestController
LOMBOK
JACKSON
javax.enterprise.context.ApplicationScoped
lombok.ToString
io.quarkus.runtime.annotations.RegisterForReflection
user
```
## Goal: codegen - Proxy
> The `implType=PROXY` will generate the proxy REST endpoint. For this implementation you need
> to add the `proxyClientClass` which is the RestClient class and the `modelPackage` needs to have
> the same value like the `RestClient`.
```xml
org.tkit.maven
tkit-mp-restclient-plugin
0.8.0
user-client
codegen
src/main/resources/user/openapi.yaml
${project.build.directory}/generated-sources/restclients
org.tkit.user.rs.proxy
org.tkit.user.rs.proxy.models
false
false
LOMBOK
JACKSON
javax.inject.Singleton
org.tkit.quarkus.log.interceptor.LoggerService
org.eclipse.microprofile.rest.client.inject.RegisterRestClient(configKey="my-client-key")
lombok.ToString
io.quarkus.runtime.annotations.RegisterForReflection
user
user-proxy
codegen
src/main/resources/user/openapi.yaml
${project.build.directory}/generated-sources/endpoints
org.tkit.user.rs.proxy
org.tkit.user.rs.proxy.models
false
false
false
PROXY
LOMBOK
JACKSON
RestController
UsersRestClient
javax.enterprise.context.ApplicationScoped
lombok.ToString
io.quarkus.runtime.annotations.RegisterForReflection
user
```
## Parameters
The plugin extends the parameter from: [Swagger maven plugin](https://github.com/swagger-api/swagger-codegen/tree/master/modules/swagger-codegen-maven-plugin)
Extended parameters:
| Name | Default | Values | Description |
|---|------------|---|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| modelPackage | | | The package name of the models |
| apiPackage | | | The package name of the `RestClient` or `RestController` |
| formatter | true | | The google source code formatter |
| apiName | | | The api name if this is set the generator will generate one file for all REST method |
| interfaceOnly | true | | Generate the interface only. If you need to generate `RestController` set this attribute to `false` |
| implType | CLASS | CLASS,INTERFACE,PROXY | This attribute is use only for `interfaceOnly=false`. The default implementation `CLASS` will generate the class with `Response 501` for each method. The `INTERFACE` value will generate the interface with default method implementation `Response 501` |
| pathPrefix | | | The path prefix for all interfaces. Example 'v2/' or '/'. REST method which starts not with this prefix will be ignored. |
| apiSuffix | RestClient | | The api interface suffix |
| annotations | | | The list of custom annotations for the interface. |
| modelAnnotations | | | The list of custom annotations for the model. |
| restClient | true | | The flag to generate the micro-profile rest client for the interface. |
| returnResponse | true | | The return type will be the Response. |
| beanParamSuffix | BeanParam | | The bean parameter suffix. |
| beanParamCount | 9 | | The number of the parameters to group by the bean parameter. |
| jsonLib | JSONB | JACKSON,JSONB | The JSON implementation. |
| fieldGen | PUBLIC | LOMBOK,GET_SET,PUBLIC | The model field generator type. |
| dateLibrary | java8 | | The date library. |
| useBeanValidation | true | | Use the bean validation on the methods. |
| apiInterfaceDoc | true | | Generate the micro-profile annotation on the generated interface. |
| groupByTags | false | | Group the REST in the openAPI schema by tags (Default by swagger). Default is false to group the REST method by path |
| basePathPrefix | | | Add in the case basePath defined in swagger contains additional part which is not included in context root. Example `basePath=/ms-rs/v2/` then add `v2/` |
| preserveEnumCase | false | | Preserve enum case names. If false (default) enum names are always uppercase and common prefix names are removed. |
## Release
### Create a release
```bash
mvn semver-release:release-create
```
### Create a patch branch
```bash
mvn semver-release:patch-create -DpatchVersion=x.x.0
```