【问题标题】:How can I generate a maven repository-ready library with swagger-codegen-maven-plugin?如何使用 swagger-codegen-maven-plugin 生成 maven 存储库就绪库?
【发布时间】:2017-05-04 04:33:18
【问题描述】:

我正在使用 Maven 插件 swagger-codegen-maven-plugin 来生成 Java 客户端 jar。我将swagger.json 放入src/main/resources 文件夹并运行mvn clean install。这是我的 pom.xml。

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.example</groupId>
    <artifactId>my-java-client</artifactId>
    <packaging>jar</packaging>
    <version>1.0-SNAPSHOT</version>
    <name>my-java-client</name>
    <url>http://maven.apache.org</url>
    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
        <swagger.version>1.5.13</swagger.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>com.google.code.gson</groupId>
            <artifactId>gson</artifactId>
            <version>2.8.0</version>
        </dependency>
        <dependency>
            <groupId>com.squareup.okhttp</groupId>
            <artifactId>okhttp</artifactId>
            <version>2.7.5</version>
        </dependency>
        <dependency>
            <groupId>com.squareup.okhttp</groupId>
            <artifactId>logging-interceptor</artifactId>
            <version>2.7.5</version>
        </dependency>
        <dependency>
            <groupId>io.swagger</groupId>
            <artifactId>swagger-codegen</artifactId>
            <version>2.2.2</version>
        </dependency>
        <dependency>
            <groupId>com.squareup.okio</groupId>
            <artifactId>okio</artifactId>
            <version>1.12.0</version>
        </dependency>
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupId>io.swagger</groupId>
                <artifactId>swagger-codegen-maven-plugin</artifactId>
                <version>2.2.2</version>
                <executions>
                    <execution>
                        <goals>
                            <goal>generate</goal>
                        </goals>
                        <configuration>
                            <inputSpec>src/main/resources/swagger.json</inputSpec>
                            <modelPackage>mypackage.model</modelPackage>
                            <apiPackage>mypackage</apiPackage>
                            <invokerPackage>mypackage.invoker</invokerPackage>
                            <language>java</language>
                            <configOptions>
                                <interfaceOnly>true</interfaceOnly>
                                <dateLibrary>java8</dateLibrary>
                                <java8>true</java8>
                            </configOptions>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
</project>

当我运行mvn clean install 时,目标文件夹中会生成一个jar 文件my-java-client-1.0-SNAPSHOT.jar。它有源代码,但没有 pom.xml 文件。在target/generated-sources/swagger 文件夹中有一个pom.xml 文件,但它有groupIdartifactId

  <groupId>io.swagger</groupId>
  <artifactId>swagger-java-client</artifactId>

target/generated-sources/swagger 中的 README.md 文件要求在您的 pom.xml 中包含以下内容以使用生成的 jar:

<dependency>
    <groupId>io.swagger</groupId>
    <artifactId>swagger-java-client</artifactId>
    <version>1.0.0</version>
    <scope>compile</scope>
</dependency>

我猜这些只是默认值,因为如果我生成多个 swagger 客户端,它们会在名称上发生冲突,我可以在 swagger-codegen 源代码中看到这些字段是从 {{artifactId}} 等占位符生成的。我找不到可以设置这些占位符的位置。

如何让 jar 包含 pom.xml 和我选择的 artifactIdgroupId,以便我可以将它上传到像 Artifactory 这样的 Maven 存储库,并在我的 Maven 依赖项中使用它?

【问题讨论】:

    标签: java maven swagger swagger-codegen


    【解决方案1】:

    没有特别详细的文档记录,但您似乎可以从 configOptions 中覆盖 artifactId、groupId 等:

    <configOptions>
        <groupId>com.your.group.id</groupId>
        <artifactId>your-artifact-id</artifactId>
        <artifactVersion>0.0.1-SNAPSHOT</artifactVersion>
    </configOptions>
    

    CodegenConstants.java 中的很多属性都可以用同样的方式设置。

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 2022-10-20
      • 2023-03-04
      • 1970-01-01
      • 2018-08-29
      • 2017-04-15
      • 2018-02-11
      • 2020-04-05
      • 1970-01-01
      相关资源
      最近更新 更多