使用Swagger记录现有的JAX-RS实现而不注释它

时间:2016-04-25 01:16:50

标签: java jax-rs swagger

我想为现有的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

这可能是一个解决方案吗?

1 个答案:

答案 0 :(得分:4)

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

您分享的链接似乎是某种黑客机制。但我不知道除非您明确声明,否则任何代码都可以找出API的意图。

如果您需要最小化swagger注释用法,有两种方法可以执行此操作:

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

  2. 在此处编写界面并使用注释。您的API类只需要扩展此接口。这将减少对现有课程的影响。

  3. 希望这有帮助。