如何覆盖默认的swgger-code-gen服务实现?

时间:2017-01-13 18:50:04

标签: java maven swagger swagger-codegen

我是swagger codegen的新手,我使用的是2.1.6版本。我试图通过yaml和swagger-codegen-maven生成休息服务。 以下是pom.xml的一部分:

.....
<plugin>
<groupId>io.swagger</groupId>
<artifactId>swagger-codegen-maven-plugin</artifactId>
<version>${io.swagger.swagger-codegen-maven-plugin.version}</version>
<executions>
    <execution>
      <id>createprod</id>
        <goals>
            <goal>generate</goal>
        </goals>
        <configuration>
            <inputSpec>${project.basedir}/src/main/resources/swagger/rest-api-create-product.yaml</inputSpec>
            <language>io.swagger.codegen.languages.JavaResteasyServerCodegen</language>
          <!--   <templateDirectory>How_do_I_use_it</templateDirectory> -->

            <output>${project.build.directory}/generated-sources</output>
            <apiPackage>${swagger.resourcePackage}.handler</apiPackage>
            <modelPackage>${swagger.resourcePackage}.model</modelPackage>
            <invokerPackage>${swagger.resourcePackage}.handler</invokerPackage>
             <configOptions>
                 <sourceFolder>src/main/java</sourceFolder>
                 <interfaceOnly>true</interfaceOnly>
                 <configPackage>com.domain.service.configuration</configPackage>
                 <serializableModel>true</serializableModel>
             </configOptions>
        </configuration>
    </execution>
</executions>
  </plugin>

<plugin>
    <groupId>org.codehaus.mojo</groupId>
    <artifactId>build-helper-maven-plugin</artifactId>
    <version>1.9.1</version>
    <executions>
        <execution>
            <id>add-source</id>
            <phase>generate-sources</phase>
            <goals>
                <goal>add-source</goal>
            </goals>
            <configuration>
                <sources>
                    <source>src/main/java</source>
                </sources>
            </configuration>
        </execution>
    </executions>
</plugin>
</plugins>  

swagger生成的ServiceImpl是:

import com.domain.servie.handler.*;
import com.domain.servie.model.*;


import com.domain.servie.model.InitSuccessResponse;
import com.domain.servie.model.FailureResponse;
import com.domain.servie.model.InitRequest;

import java.util.List;
import com.domain.servie.handler.NotFoundException;

import java.io.InputStream;

import javax.ws.rs.core.Response;
import javax.ws.rs.core.SecurityContext;

@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaResteasyServerCodegen", date = "2017-01-13T12:19:29.084-06:00")
public class InitWfApiServiceImpl extends InitWfApiService {

      @Override
      public Response createProductPost(String apiKey,InitRequest body,SecurityContext securityContext)
      throws NotFoundException {
      // do some magic!
      return Response.ok().entity(new ApiResponseMessage(ApiResponseMessage.OK, "magic!")).build();
  }

}

在这里,我想将请求处理映射到我自己的请求处理程序,而不是return Response.ok().entity(new ApiResponseMessage(ApiResponseMessage.OK, "magic!")).build();,我不想将其硬编码为其余的api。

这个想法是,rest-api是可重用的(jar文件)。包含rest-api作为依赖jar的系统将负责构建战争。包装结构是给我的一种石刻要求。 :)

有没有人知道我如何覆盖这个ServiceImpl代码而不做一些像删除DefaultCodeGen等疯狂的事情?是否可以使用模板来实现这一目标?

非常感谢任何意见。

2 个答案:

答案 0 :(得分:1)

生成该部分代码的模板是this one。 您应该能够通过更改模板来实现所需的行为。

答案 1 :(得分:0)

当您想使用自定义模板时,您可以使用以下方法:

在 maven 中添加另一个插件来下载包含自定义模板的 maven 依赖项,例如,您可以将它们上传到您的本地工件。 在这种情况下,工件称为 swagger-templates 及其版本 0.0.1。

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-remote-resources-plugin</artifactId>
  <configuration>
    <resourceBundles>
      <resourceBundle>our.mvn.group:swagger-templates:0.0.1</resourceBundle>
    </resourceBundles>
  </configuration>
  <executions>
    <execution>
      <phase>initialize</phase>
      <goals>
        <goal>process</goal>
      </goals>
    </execution>
  </executions>
</plugin>

然后在 swagger-codegen-maven-plugin 配置部分确保引用正确的目录,添加:

<templateDirectory>${project.build.directory}/maven-shared-archive-resources/subdir</templateDirectory>

其中 subdir 是包含自定义模板的 maven 工件的 src/main/resources 目录中的子目录。你可以把你的胡子文件放在那里。