问题标签 [swagger-ui]

我们如何将“groovy”类的模型中的元类属性排除为响应？我有一个 Jax-Rs 资源，它返回一个用 swagger @ApiModel 注释的 groovy 对象。我在 swagger ui 中看到了太多常规的特定属性。如何从序列化中排除它？

似乎是在使用 Jackson 进行 pogo-json 序列化？如何注释我的 groovy 类以排除元类属性进入 json 序列化字符串？我尝试使用 JsonIgnoreProperties 注释，但没有帮助。

我是招摇世界的新手。我从 github 下载了 wordnki/swagger-core 并部署了 java-jaxrs 示例。url http:localhost:8080/api/api-docs/pet 返回响应。我想在 swagger-ui 中查看此内容。

我添加了 swagger-ui 目录，其中包含所需的 js 和 html 文件。如何配置我的 web.xml 来查看这个 swagger-ui？这样我就可以在 swagger url 中将我的资源配置为 http:localhost:8002/api/api-docs。

我目前正在使用 Eclipse、Spring Framework MVC 创建一个 API Rest，并且我刚刚添加到我的项目中。我可以访问 swagger 的 json 结果，但我需要添加 swagger ui。

这是我为 swagger-springmvc 创建的所有文件：

WebAppInitializer.java

SpringSwaggerConfiguration.java

}

SpringBaseWebConfiguration.java：

这是我的 3 个文件，可将 swagger 添加到我的项目中，atm 我只是决定只检查 1 个方法，即：

我的结果：我可以访问以下网址http://localhost:8080/ApiDark/ws/api-docs，但我得到的 json 值如下：

{"apiVersion":"1","swaggerVersion":"1.2","authorizations":{"basicAuth":{"type":"basicAuth"}},"info":{"title":"Swagger Spring MVC对于 Dark Api","description":"演示如何在无 XML 环境中使用 swagger-springmvc 的示例应用程序。","termsOfServiceUrl":" http://en.wikipedia.org/wiki/Terms_of_service ","contact ":"michael@laccetti.com","license":"Apache 2.0","licenseUrl":" http://www.apache.org/licenses/LICENSE-2.0.html "}}

这就是我决定添加 swagger-ui 的原因。我将 dist 文件夹的内容（取自swagger-ui）添加到我的 src/main/webapp 文件夹中。并修改 index.html 的内容以指向我的 url ：

但是我无法访问 swagger-ui 界面，我只有 json 结果...需要帮助才能使其正常工作！

我有一个带有文件上传方法的 Jersey 服务，看起来像这样（简化）：

它可以工作，我可以使用 Chrome 中的 Postman 扩展成功测试它。

但是，Swagger 看到 2 个名为“file”的参数。不知何故，它似​​乎理解InputStream参数和FormDataContentDisposition参数实际上是同一file参数的 2 个部分，但它看不到FormDataBodyPart参数。

这是参数的 Swagger JSON：

因此，Swagger UI 为 FormDataBodyPart 参数生成一个文件选择器字段和一个额外的文本字段：

因此，当我在 Swagger UI 中选择一个文件并提交表单时，我最终会读取 InputStream 中文本字段的内容，而不是上传文件的内容。如果我将文本字段留空，我会得到文件的名称。

如何指示 Swagger 忽略 FormDataBodyPart 参数？

或者，作为一种解决方法，如何在没有 FormDataBodyPart 对象的情况下获取上传文件的媒体类型？

我使用 Jersey 2.7 和 swagger-jersey2-jaxrs_2.10 版本 1.3.4。

api-docs 早些时候工作正常。它停止工作，现在我得到了

如果我更改 src/main/webapp/swagger-ui/index.html

我得到“无法从服务器读取。它可能没有适当的访问控制源设置。”

我目前正在为我的 spring MVC RESTful 服务项目争取一个招摇的配置。我决定遵循swagger-spring但我不明白 swagger 的 UI 部分是否应该是一个完全不同的项目，还是应该驻留在容器的相同上下文中？

我基于 spring mvc 的 RESTFul 服务中的 swagger json 正确显示在如下链接上：http://<server>:<port>/<context>/api-docs但是每当我在应用程序中放入 swagger UI 组件（JSP、CSS 和 JS 文件）时，我都无法访问 swagger UI，它应该看起来像这样。

I read the following here:

Swagger does not currently include a suggestion for supporting multiple API versions from a client or server point of view—versioning information (both of the spec and the underlying API implementation) are declared.

What I wish to know is that how to configure swagger UI to show the API for multiple services, i.e. services residing on different servers. I tried working with configuring the swagger UI on a different server but I get the following error:

Can't read from server. It may not have the appropriate access-control-origin settings.

I have read about enabling CORS on the server but that did not help in my case as the services run on liberty profile.

Swagger UI is configured on a locally running liberty profile of WAS and the services run on a different WAS instance.

The direction I am moving is to have UI for multiple services, but this I thought is a logical starting point.

我正在关注http://raibledesigns.com/rd/entry/documenting_your_spring_api_with上的文章。

一切正常，但无法集成 Swagger UI。

导致 /error 重定向。

我在下面定义了 api 端点：

我无法从 Swagger 生成的 UI 中传递数组。如果我输入[1, 2, 3, 4]或ids%5b%5d=1&ids%5b%5d=2&ids%5b%5d=3然后两者都无效。如果我使用数组从规范调用 api，它就可以工作。我的客户想尝试 Swagger 的整个 api，所以我想要一个适用于 Swagger UI 的解决方案。

这是我的接口 ClassA .java

这是我的实现类。

Application-context.xml 条目

web.xml 条目

当我将这些条目从接口移动到实现类时。我能够访问 swagger 中的其余端点。swagger 正在工作。但是当我将该注释放在接口本身中时。它不起作用。