问题标签 [swagger-ui]

我正在尝试将 Swagger-ui 用于由 php 编写的 json-rpc 服务器。我使用Swagger-PHP为 Swagger-ui 生成 json 投诉容器。所以，我对 Swagger 很陌生，我对这样的方法使用注释：

在 SWG\Operation 中，我需要添加一个与 json-rpc spec对应的“方法” 。因此，所有请求都将使用 POST 方法作为 http 的一部分，而 json 容器将为每个请求都有自己的“方法”。

问题 - 我应该从哪里开始寻找解决这个问题？

对不起我的英语不好。不是本地人。

我有一个 spring webapp，我添加了 swagger 和 swagger-ui。我添加了一个虚拟类来测试招摇：

在构建/部署之后，我可以在 swagger 页面上看到虚拟类（参见附件1）。问题是，“列表操作”没有显示任何内容。原始输出如下：

我认为，问题是缺少标签“操作”或类似的东西......但我不确定（我不知道如何解决这个问题）。有什么建议么？

我正在使用 Apache-CXF REST 服务并使用 swagger 作为文档。基于环境 (dev/qa/prod) 的 API 更改的默认值。我想将默认值（在本例中为 -5247710000779009）外部化到一个属性文件，我已经基于 env 为不同目的维护了该文件。

我怎样才能做到这一点？

我正在使用 swagger ui 插件来记录我的 web api。我想返回 JSON 对象，如：

注意 Person 对象名称。

我可以使用以下代码执行此操作：

不幸的是，因为返回类型是 HttpResponseMessage 而不是 Person 本身，所以 Swagger 只是将模型显示为 HttResponseMessage。那不是我想要的。

如果我将返回类型更改为 Person 并返回一个 person 对象，我不会在 JSON 返回中获得 Person 对象名称。那只返回 -

}

有没有办法返回 Person 但有带有 Person 对象名称的 JSON 字符串？

我正在使用enunciate为 REST API生成Swagger文档。我的一个遗留 bean 包含一个 Map，Swagger 对此抱怨：

是否有任何注释可以放入 bean 类中，以便 Swagger 可以处理这个问题？

除此之外，有没有办法告诉 Swagger 简单地忽略该领域或整个班级？我知道 Swagger 会忽略没有@XmlRootElement注释的类，但BazBean可悲的是在另一个接受 XML 的端点中使用。

看到这个问答，但没有与 OP 相同的结果如何以招摇的方式发布文件？

在我的 swagger-node-express API 中使用此规范

当我通过 curl 发布时，curl -v -F file=@scrot.png http://127.0.0.1:3000/uploads/file一切都按预期工作。当我通过 swagger-ui (v 2.0.2) 发布时，它失败了。我在这两种情况下都使用了代理，并且 swagger-ui 没有指定内容类型，也没有传递数据。

通过 curl 缩写的原始帖子（使用上面的命令）

通过 swagger-ui 缩写的原始帖子

我应该如何配置我的路由/规范，以便 swagger-ui 正确发布？

我正在尝试使用 Swagger 记录使用 ServiceStack 3.9.70 创建的休息服务...

这是解决方案的布局：

使用 swagger-ui，我设置了 discoveryUrl: "/resources"

启动 swagger html 时，只有Product{n}.cs 之一中的操作显示. 运行 /metadata 时会显示所有操作。

这与我构建解决方案的方式有关吗？

我正在使用 Grape（在 Rails 4 上）、Swagger 和 Swagger-UI 来记录我的 Grape API。现在我想知道如何像 Swagger 示例那样对路线进行分组：http: //petstore.swagger.wordnik.com/

这就是我的 Swagger-UI 当前的外观：

我试图让 Swagger 与 ServiceStack 一起工作。Web 服务器位于防火墙后面，可从 Internet (my.domain.de:80) 访问。然后将请求转发到端口 8070 上的 Web 服务器。

在访问 swagger 页面时，它能够访问/api/resources和检索 ServiceMethods 列表，但随后无法检索到操作列表。

当我使用提琴手检查结果时，我发现他不见了，因此大摇大摆地尝试从而不是/api获取操作列表。/resources/ServiceName/api/resources/ServiceName

Swagger-UI 给我以下错误消息：

无法从路径http://my.domain.de/resource/ServiceName读取 api 'ServiceName' （服务器返回 Not Found）

招摇配置：

服务栈配置：

更新（2） 如果我没有在 ServiceStacks 资源服务的初始响应中设置 WebHostUrl BasePath 包含来自 webserver 的端口号basePath=http://my.domain.de:8060/api。但是在防火墙上这个端口是不可访问的，我们也不希望它是可访问的。

web.config：

更新

在初始响应中，基本路径是：

my.domain.de 我的意思是一个真实世界的 url，它只是没有端口、url-path、查询字符串或片段的主机名（我实际上检查了维基百科的正确名称；）

我在 StackOverflow 上找到了另一个问题，但它对我没有帮助。 带有服务堆栈的招摇不工作

如何让 ServiceStack/Resources Service/api为其返回的 ServiceList 添加？

关于泛型类型响应对象的文档，我对 Swagger 的 ServiceStack 实现有疑问。强类型的响应对象被正确记录和显示，但是一旦将泛型类型的对象用作响应，则文档不准确且具有误导性。

请求 DTO

响应 DTO

响应 DTO 类型

这些例子非常简单。没有什么真正的 hacky 或聪明的事情发生，但这是我从 Swagger 获得的开箱即用的示例文档：

如您所见，泛型类型没有正确记录，而是使用了其他类型。由于我对所有响应都使用相同的 ServiceResponse 包装器，因此这种情况正在全面发生。