你好,
也许四年后答案来得有点晚,但迟到总比没有好。
如果你有一个正确的招摇文件(不仅仅是一个片段),如下所示
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>
好看,
不管你现在是什么!