我真的需要创建swagger.json和swagger.yaml才能使用Swagger将文档作为其余的应用程序

时间:2017-01-13 21:36:44

标签: javascript rest jersey swagger

我花了一整天的时间跟随Swagger的指导,基本上告知在添加了swagger依赖并部署/启动之后,我会根据Swagger注释(例如@Api)使用两个文件来描述我的休息服务。首先,目前尚不清楚这两个文件是在编译后还是在某个特定阶段(部署到服务器,任何特定的maven阶段或目标,或容器启动)时创建的。好吧,如果我能够完成并运行,那么这根本不是问题(请参阅I can't get swagger.json neither swagger.yaml created althought I followed the guidance step by stephttps://stackoverflow.com/questions/41622018/i-cant-deploy-my-application-to-apache-tomcat-8-after-i-added-swagger-jersey-j我的困难。

我之前尝试运行其他人提供的简单示例,而不是遵循官方guidande,并且没有使用swagger.json和swagger.yaml。

完全由作者承诺的三个示例(公开文档和测试功能): 1 - https://dzone.com/articles/swagger-make-developers-love 2 - https://sdngeeks.wordpress.com/2014/08/01/swagger-example-with-java-spring-apache-cxf-jackson/ 3 - https://github.com/JakubStas/Spring4WithSwagger/blob/master/README.md

然而,它们都没有创建或似乎依赖于这两个文件。所以,我直截了当的问题是:我真的需要这些文件来将我当前的Rest Services应用程序集成到Swagger吗?

如果没有,作为补充点,什么可以是一种常见的方法或方法来集成它而不依赖于这些文件?我注意到所有三个例子都有一些文件没有在我正在遵循的官方Swagger指南中描述(例如,swagger-ui.js,swagger-ui.min.js)。我明白这个问题似乎很大。因此,为了缩小范围,我计划使用backbone-min.js + swagger.js + underscore-min.js基于这三个例子的相同想法。

PS。官方指导我的意思是https://github.com/swagger-api/swagger-core/wiki/Swagger-Core-Jersey-1.X-Project-Setup-1.5#configure-and-initialize-swagger

0 个答案:

没有答案