如何在我的应用程序中集成swagger-ui

时间:2015-04-07 16:53:53

标签: swagger swagger-ui

我正在尝试将swagger与camel项目集成

遵循此示例https://github.com/smparekh/camel-example-servlet-rest-tomcat

如何使用此示例项目访问swagger-ui?

我在tomcat中删除了war文件。

并访问http://localhost:8080/camel-example-servlet-rest-tomcat/api-docs我得到了这个......

{“apiVersion”:“1.2.3”,“swaggerVersion”:“1.2”,“apis”:[{“path”:“/ user”,“description”:“用户休息服务”}],“ info“:{”title“:”User Services“,”description“:”使用Swagger提供用户REST服务的Camel Rest示例“}}

但我的问题是 - 我如何访问swagger-ui / index.html?

访问swagger-UI的确切URL是什么?

5 个答案:

答案 0 :(得分:8)

您必须将swagger-ui的dist文件夹的内容复制到项目的webapp文件夹中。

在index.html中,

  window.swaggerUi = new SwaggerUi({
  url: "http://petstore.swagger.wordnik.com/api/api-docs",
  dom_id: "swagger-ui-container",

你必须用这个

替换url
 http://localhost:8080/camel-example-servlet-rest-tomcat/api-docs

有关详情,请点击此链接整合swagger-ui。

https://github.com/swagger-api/swagger-ui

答案 1 :(得分:1)

如果您按原样复制了dist文件夹,请

http://localhost:8080/camel-example-servlet-rest-tomcat/ {basepath} /dist/index.html。如果您已重命名dist文件夹,请使用新名称而不是dist。将basepath替换为您在web.xml中配置的basepath。该代码片段如下所示:

<init-param>
<param-name>swagger.api.basepath</param-name>
<param-value>/rest</param-value>
</init-param>

答案 2 :(得分:1)

您应该使用http://localhost:${port}/${contextPath}/swagger/index.html

答案 3 :(得分:0)

这些是您的Swagger文档:

{"apiVersion":"1.2.3","swaggerVersion":"1.2","apis":[{"path"...

现在你需要Swagger-UI来使用它们。您可以将安装在任何地方。没有硬性要求将Swagger-UI放入项目中。您只需编辑index.html文件以指向您的文档路径(上面的JSON输出。)

答案 4 :(得分:0)

要访问swagger2,是

http://localhost:${port}/${contextPath}/swagger-ui.html