14

我使用 swagger codegen 生成 jaxrs 服务器端类和客户端 java 类。

这是我用来生成类的命令

java -jar modules/swagger-codegen-distribution/target/swagger-codegen-distribution-2.1.2-M1.jar   -i /Users/me/Workspace/swagger-codegen/samples/yaml/echo.yaml   -l jaxrs   -o samples/server/echo/java

生成的服务器代码有一个占位符来写我的“魔法”。

public Response echo(@ApiParam(value = ""  )@HeaderParam("headerParam") String headerParam,
    @ApiParam(value = "",required=true) @QueryParam("message") String message)
      throws NotFoundException {
      // do some magic!
      return Response.ok().entity(new ApiResponseMessage(ApiResponseMessage.OK, "magic!")).build();
  }

我在“echo”方法中添加了“魔法”并重新生成了代码,结果却发现它消失了。避免丢失自定义代码的一种方法是修改 codegen 模板以生成接口而不是类。然后我可以在实现的类中拥有所有自定义代码。

我试图找出是否有一种方法可以在重新生成代码之后保留自定义“魔法”,或者是否有比更改模板生成接口而不是类更好的方法来处理这种情况。

4

3 回答 3

7

最新的Swagger Codegen大师允许您在代码生成期间在 .swagger-codegen-ignore(类似于 .gitignore)中指定不被覆盖的文件。

请拉最新版的 Swagger Codegen 高手试一试。

更新:2018 年 5 月,Swagger Codegen 的大约 50 位顶级贡献者和模板创建者决定分叉 Swagger Codegen 以维护一个名为OpenAPI Generator的社区驱动版本。请参阅问答以获取更多信息。

于 2016-07-08T06:44:41.210 回答
2


你好,
也许四年后答案来得有点晚,但迟到总比没有好。

如果你有一个正确的招摇文件(不仅仅是一个片段),如下所示

openapi: "3.0.0"
:
paths:
  /example:
    get:
      operationId: showIt
:

并且您运行代码生成,在没有任何代码生成特定配置值(您可以从 Swagger 编辑器下载)的jaxs-jersey-server 的说明中,您会得到大量的 java 类,如下所示:

io.swagger.api.          ExampleApi
io.swagger.api.          ExampleApiService
io.swagger.api.factories.ExampleApiServicefactory
io.swagger.api.impl.     ExampleApiServiceImpl

在 REST 端点实现ExampleApiServiceImpl中,您或多或少会看到如下内容:

package io.swagger.api.impl;

:
import ... ;
:

@javax.annotation.Generated(...)
public
class   ExampleApiServiceImpl
extends ExampleApiService
{
    // ...
    @Override
    public
    Response showIt( /* additional parameters , */ SecurityContext securityContext)
    throws NotFoundException
    {
        // do some magic!
        return Response.ok()
                       .entity(new ApiResponseMessage( ApiResponseMessage.OK
                                                     , "magic!"
                                                     )
                              )
                       .build();
    }
    // ...
}

你现在交换魔法评论了吗

        // do some magic!

通过也许以下

        String className = this.getClass().getSimpleName();
        System.out.println("Entered REST endpoint: path=|" + className.substring(0, className.length() - 14) + "| operationId=|showId|");

如果您在完成mvn clean package jetty:run. 但这不是一个好主意,正如您意识到的那样,因为在下一代之后,您的更改就消失了。

在这种情况下,手动更改生成的代码绝不是一个好主意,因为这必须有很好的记录,以至于未来的同事(可能在几个月或几年后甚至是你)即使在星期一晚上的星期日半睡半醒也会使下一次代码生成后再次更改。但是我 20 多年使用不同代码生成器的经验只说明了这一点:算了吧! 出于同样的原因,在第一代之后阻止进一步的生成并不是真正面向目标的,因为这也必须被广泛记录。否则,调试时间超过调试时间可能会找出新功能不起作用的故障排除。

但这都不是必要的。
在生成的类io.swagger.api.ExampleApi 中会找到如下构造函数(好吧,就是2019-05-17的状态。不知道是不是和四年前一样(或相似) )

package io.swagger.api;

:
import ... ;
:

@Path("/example")

@javax.annotation.Generated(...)
public class ExampleApi
{
   private final ExampleApiService delegate;

   public ExampleApi(@Context ServletConfig servletContext)
   {
      // ...
      if (servletContext != null) {
         String implClass = servletContext.getInitParameter("ExampleApi.implementation");
         if (implClass != null && !"".equals(implClass.trim()))
         {
            try
            {
               delegate = (ExampleApiService) Class.forName(implClass).newInstance();
            }
            catch (Exception e)
            {
               throw new RuntimeException(e);
            }
         } 
      }
      // ...
    }
// ...
}

重要的一段代码是servletContext.getInitParameter("..."). 如果您现在在 servlet 配置中指定一个ExampleApi.implementation具有完整限定 java 类名的名称的键,该名称源自ExampleApiService您已经实现了您自己的端点代码,该端点代码对于覆盖未来的代码生成是安全的。

为了完成示例,该规范将在(附加生成的,oouuch,抱歉,您不能拥有所有内容)web.xml文件中进行。该文件包含以下内容:

    <servlet>
        <servlet-name>jersey</servlet-name>
        <servlet-class>org.glassfish.jersey.servlet.ServletContainer</servlet-class>
        ...
        <load-on-startup>1</load-on-startup>
    </servlet>

在这个 xml 片段中,您必须在句点(代表其他 servlet 配置设置)之后插入以下内容:

        <init-param>
            <param-name>ExampleApi.implementation</param-name>
            <param-value>my.swagger.api.MyExample</param-value>
        </init-param>

好看,
不管你现在是什么!

于 2019-05-17T15:12:47.343 回答
1

您可以在文件中指定要忽略的.swagger-codegen-ignore文件

这是文件的示例自我解释自动生成.swagger-codegen-ignore代码

# Swagger Codegen Ignore
# Generated by swagger-codegen https://github.com/swagger-api/swagger-codegen

# Use this file to prevent files from being overwritten by the generator.
# The patterns follow closely to .gitignore or .dockerignore.

# As an example, the C# client generator defines ApiClient.cs.
# You can make changes and tell Swagger Codgen to ignore just this file by uncommenting the following line:
#ApiClient.cs

# You can match any string of characters against a directory, file or extension with a single asterisk (*):
#foo/*/qux
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux

# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
#foo/**/qux
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux

# You can also negate patterns with an exclamation (!).
# For example, you can ignore all files in a docs folder with the file extension .md:
#docs/*.md
# Then explicitly reverse the ignore rule for a single file:
#!docs/README.md

您可以在下面添加一些行来忽略例如我想忽略文件夹impl中的所有文件所以我添加了以下行来做到这一点

**/impl/*
于 2019-01-02T12:04:54.627 回答