如何使用swagger-codegen-maven-plugin生成maven存储库就绪库?

时间:2017-05-04 04:33:18

标签: java maven swagger swagger-codegen

我使用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文件。 pom.xml文件夹中有一个target/generated-sources/swagger文件,但它包含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源代码中看到这些字段是从{{1}这样的占位符生成的}。我还没有找到可以设置这些占位符的地方。

如何让jar包含{{artifactId}} pom.xmlartifactId我选择的内容,以便我可以将其上传到Maifact资源库,如Artifactory,并将其用于我的Maven依赖?

1 个答案:

答案 0 :(得分:3)

它没有特别好的文档记录,但看起来你可以在configOptions中覆盖artifactId,groupId等:

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

CodegenConstants.java中的许多属性都可以以相同的方式设置。