Swagger和SpringFox

Swagger和SpringFox

最受欢迎的API文档规范之一是OpenApi，以前称为Swagger。
它允许您使用JSON或YAML元数据描述API的属性。
它还提供了一个Web UI，它可以将元数据转换为一个很好的HTML文档。
此外，通过该UI，您不仅可以浏览有关API端点的信息，
还可以将UI用作REST客户端 - 您可以调用任何端点，指定要发送的数据并检查响应。
它非常方便。

然而，手动编写此类文档并在代码更改时保持更新是不现实的。
这就是SpringFox发挥作用的地方。
它是Spring Framework的Swagger集成。
它可以自动检查您的类，检测控制器，它们的方法，它们使用的模型类以及它们映射到的URL。没有任何手写文档，只需检查应用程序中的类，
它就可以生成大量有关API的信息。
多么酷啊？最重要的是，每当您进行更改时，它们都会反映在文档中。