java - 使用 Swagger 记录现有的 JAX-RS 实现而不对其进行注释

Question

我想为现有的 JAX-RS 实现生成 Swagger 文档，而无需修改我的代码。我希望不必引入任何类型的 Swagger 注释来装饰我的类。

这里

https://github.com/swagger-api/swagger-core/wiki/Swagger-Core-JAX-RS-Project-Setup-1.5.X .

他们似乎建议在将您的应用程序配置为使用 Swagger 之后，您必须为 swagger 注释代码才能生成 swagger.json。我对吗？需要注解吗？如果不是，我不太明白他们的目的

在不修改代码的情况下记录现有 JAX-RS 应用程序的魔法是否可行？

我找到了这个 http://www.adam-bien.com/roller/abien/entry/jax_rs_get_swagger_json .

这会是一个解决方案吗？

Answer 1

将文档添加到您的 JAX-RS 实现中需要 Swagger 注释。目的是定义您的 API 操作和参数，它们的含义和目的是什么。

您共享的链接似乎是某种黑客机制。但我看不出任何代码如何找出您的 API 的意图，除非您明确声明它。

如果您需要尽量减少 swagger 注释的使用，有两种方法可以做到这一点:

1. 仅在类级别使用@Api，不使用方法级别注释。这将呈现一个基本的 swagger.json，其中包含您的 GET/POST 等 API 列表。

2. 写一个接口(interface)，这里使用注解。然后你的 API 类只需要扩展这个接口(interface)。这将减少对您现有类(class)的影响。

希望这对您有所帮助。