[英]How to change "APIClient" name
我正在嘗試從 swagger-codegen-maven-plugin(版本 3.0.8)和(組 ID:io.swagger.codegen.v3)自動生成類,如下所示。 代碼生成效果很好,但是我想將 Generated ApiClient 的名稱更改為 PREFIX+ApiClient 之類的名稱(例如:customApiClient,其中 custom 是前綴)。
<build>
<finalName>cdm-customer-servicing-api-client</finalName>
<plugins>
<plugin>
<!-- This 2019 version is required for OpenAPI 3 -->
<groupId>io.swagger.codegen.v3</groupId>
<artifactId>swagger-codegen-maven-plugin</artifactId>
<version>3.0.8</version>
<executions>
<execution>
<goals>
<goal>generate</goal>
</goals>
<configuration>
<inputSpec>${project.basedir}/src/main/resources/spec.json</inputSpec>
<language>java</language>
<apiPackage>*****.client.api</apiPackage>
<modelPackage>*******. client.model</modelPackage>
<configOptions>
<groupId>${project.groupId}</groupId>
<artifactId>${project.artifactId}</artifactId>
<artifactVersion>${project.version}</artifactVersion>
<library>resttemplate</library>
<java8>true</java8>
<dateLibrary>java8</dateLibrary>
<licenseName>Apache 2.0</licenseName>
<licenseUrl>https://www.apache.org/licenses/LICENSE-2.0</licenseUrl>
</configOptions>
<additionalProperties>
<property></property>
</additionalProperties>
<generateApiTests>false</generateApiTests>
<generateModelTests>false</generateModelTests>
<generateApiDocumentation>false</generateApiDocumentation>
<generateModelDocumentation>false</generateModelDocumentation>
</configuration>
</execution>
</executions>
</plugin>
上面的定義生成模型,在 YML 規范中指定的 api,沒有問題。 它還生成 ApiClient.java,它在所有 API 類中自動裝配。 我想更改 ApiClient.java 的名稱以添加一些前綴或后綴。
原因是:我確實有 2 個服務規范,我想確保來自一個服務的 ApiClient 不會覆蓋另一個 ApiClient。
讓我知道是否有人有運氣。
可以實現擴展JavaClientCodegen.java
的自定義生成器。
./gradlew clean openApiMeta
創建骨架(找不到 mvn 等效項)src/
└── main
├── java
│ └── org
│ └── openapitools
│ └── codegen
│ └── CustomJavaGenerator.java
└── resources
├── customjava
│ └── CustomApiClient.mustache
└── META-INF
└── services
└── org.openapitools.codegen.CodegenConfig
public class CustomJavaGenerator extends JavaClientCodegen implements CodegenConfig {
private final Logger LOGGER = LoggerFactory.getLogger(JavaClientCodegen.class);
private static final String CUSTOM_API_CLIENT_PREFIX = "customApiClientPrefix";
@Override
public void processOpts() {
super.processOpts();
final String invokerFolder = (sourceFolder + '/' + invokerPackage).replace(".", "/");
String customPrefix = "DefPref";
if (additionalProperties.containsKey(CUSTOM_API_CLIENT_PREFIX)) {
customPrefix = additionalProperties.get(CUSTOM_API_CLIENT_PREFIX).toString();
LOGGER.warn("client custom name: " + customPrefix + "ApiClient.java" );
}
supportingFiles.removeIf(e -> "ApiClient.java".equals(e.getDestinationFilename()));
supportingFiles.add(new SupportingFile("CustomApiClient.mustache", invokerFolder, customPrefix + "ApiClient.java"));
}
@Override
public String getName() {
return "javaCustom";
}
}
org.openapitools.codegen.CustomJavaGenerator
resources/customjava/CustomApiClient.mustache
並替換ApiClient
的每個實例(區分大小寫),如圖所示public class {{customApiClientPrefix}}ApiClient {...
Package 並安裝項目,使其出現在 mavenLocal 存儲庫中,例如customjava-openapi-generator-1.0.0.jar
。
在本例中,使用 gradle生成代碼。
將自定義 jar 添加到類路徑,並將openApiGenerate
配置添加到 gradle.build。 maven 應該類似。
buildscript {
repositories {
mavenLocal()
jcenter()
maven { url "https://repo1.maven.org/maven2" }
}
dependencies {
// other dependencies
// custom generator
classpath "org.openapitools:customjava-openapi-generator:1.0.0"
classpath "org.openapitools:openapi-generator-gradle-plugin:5.1.0"
}
}
repositories {
jcenter()
}
apply plugin: 'org.openapi.generator'
openApiGenerate {
//verbose = true
generatorName = "javaCustom"
inputSpec = "$rootDir/generate/proj-swa01-1.0.0-resolved.yaml".toString()
outputDir = "$buildDir/generated".toString()
apiPackage = "org.openapi.example.api"
invokerPackage = "org.openapi.example.invoker"
modelPackage = "org.openapi.example.model"
templateDir = "customjava"
configOptions = [
dateLibrary: "java8"
]
additionalProperties = [
customApiClientPrefix: "Swa"
]
}
/gradlew clean openApiGenerate
聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.