为Springfox生成Swagger :Springfox还是发音

Question

如果您想为Spring项目生成Swagger文档，基本上您有两个选项:阐明和SpringFox。

我深入研究了这个问题，但没有找到一个更好的意见。

在我看来，宣言看起来更好，因为它完全是在你的项目外部。不需要添加带有配置的特殊Bean，也不需要引用带有注释的附加包，并使用它们对控制器进行注释。您只需简单地将JavaDoc与自定义标记一起使用，它就可以完成这项工作。

是否还有其他考虑因素要考虑？

谢谢。

Answer 1

在使用这两种方法之后，我发现了以下主要区别：

• Springfox在构建时评估注释，从应用程序上下文中读取Springfox配置(构建时间与运行时)
• 声明可以使用Javadocs作为文档的一部分(构建和运行时)
• Springfox需要一个测试来生成一个可以用于进一步代码生成的swagger配置文件，这并不适合标准的maven生命周期。我更喜欢使用generate-sources / generate-resources来生成代码/文档。对于springfox，我只能在运行测试之后进行生成。
• Springfoxwithspringfox-swagger-ui是一种非常简单的方法，可以在现有Springfox / MVC应用程序的基础上实现一个高傲的UI。OTOH，与生成的Swagger一起使用像ReDoc这样的工具几乎同样简单，但更灵活。
• Springfox需要在应用程序中进行相当多的配置，因此您的应用程序将对Springfox具有运行时依赖关系。