如何从vert.x打开Swagger-ui

Question

我想在Vert.X应用程序中实现Swagger-UI。我已经列出了所有路由，希望能像SpringBoot一样在swagger-ui中看到它们。我也已经手动编辑过swagger-editor中的内容。那么，如何从vert.x应用程序打开localhost：8080/swagger-ui.html，并在那里查看所有路由。

我读到需要保存swagger-editor中的json，并将其放入src / resources中。之后怎么做？

此外，我在这里发现了一个很棒的东西：https://github.com/phiz71/vertx-swagger 和 http://vertx.io/blog/presentation-of-the-vert-x-swagger-project/ 不过，如何实现呢？

- xmlParser

Answer 1

你的方向有点偏了。这些示例演示了如何从Swagger文件构建VertX应用程序，而你想要的是通过VertX提供Swagger UI。

我为您提供了一个示例项目:

https://github.com/AlexeySoshin/VertxSwaggerUI

打开 http://localhost:8080/swagger/，您将看到所有Swagger文档，就像往常一样。

如果您想自己完成:

1. 将 https://github.com/swagger-api/swagger-ui/tree/master/dist 内容复制到您的资源/webroot目录下
2. 与这些文件一起放置swagger.json
3. 在VertX中创建StaticHandler：router.route("/*").handler(StaticHandler.create());

- Alexey Soshin

---

我已经做了。非常感谢！但现在的问题是，每当我们添加新路由时，就必须编辑swagger.json文件。使用Spring Boot则可以自动完成。因此，是否有可能在添加新路由时，在Swagger文档中看到它而无需编辑swagger.json文件？ - xmlParser

你在使用 SpringFox Swagger2 吗？ - Alexey Soshin

我认为在使用vert.x时，它与Spring Boot的工作方式不同。我错了吗？ - xmlParser

在VertX中我不知道有这样的项目。我猜可能可以开发类似的东西，但我不确定它是否会像Spring那样好用。VertX关于端点的数据不如Spring多。 - Alexey Soshin

@AlexeySoshin，使用这个解决方案，我只能看到宠物商店的JSON数据，我们需要根据Java控制器动态创建Swagger。 - The Strong Programmer

@AlexeySoshin 謝謝您的示例，對我有很大幫助！我看到您在swagger index.html中引用了petstore - 如果您想從項目中提供swagger.json，URL應該是“"./swagger.json"”而不是“"http://petstore.swagger.io/v2/swagger.json"”（當然，在您的示例中，由於您也在提供petstore，這兩者是相同的）。 - s-heins