问题标签 [swagger-ui]

I have a project that was using the ServiceStack with Swagger-UI, I have installed and setup this up with v4.0.24 and recently upgraded to v4.0.30.

The latest ServiceStack.Api.Swagger NuGet package : https://www.nuget.org/packages/ServiceStack.Api.Swagger/ Does not seem to install the /swagger-ui resource folder as the previous package did.

I tried this with a new clean servicestack asp.net solution in VS2013. Added ServiceStack.Api.Swagger from nuget, and enabled the plugin in AppHost.cs thus :

The swagger-ui feature seems to works fine, but it appears the resources (index.html, js, css, etc.) are embedded in the dll, and it is required to edit the index.html at a minumum to configure Swagger-UI.

Am I missing something, or is this a bug in the latest NuGet package?

I have edited my swagger v4.0.24 html, css and js, am I safe to pull these from the ServiceStack Git (https://github.com/ServiceStack/ServiceStack/tree/master/src/ServiceStack.Api.Swagger) and manually add / merge them to my solution?

我在 VS2013 中有一个解决方案，其中包含几个类库和一个 Web API 项目。我在设置 Swagger UI 时遇到了一些问题。首先，当我为我的 Web API 项目设置 swashbuckle 时，我只能指向一个文档 XML 文件。有没有办法指向包含多个 XML 文件，这样 Swagger 不仅可以为我在控制器中的路由获取文档，还可以从我的其他项目中获取域对象？这是我来自 SwaggerConfig.cs 的代码

如果我添加多个 XML 文件，它只会从 IncludeXmlComments 中获取最后一个文件。

其次，我在以 JSON 格式返回时，我的 DTO 使用的是驼峰式大小写

但是，当我在 Swagger UI 的响应类中查看响应模型和模型架构时，我看到的是确切的类属性名称，而不是在命中端点时返回的 JSON 架构。有没有办法在 Swagger UI 文档页面中显示确切的 JSON 模式？

如何指定 swagger 文档注释以在 Java bean 中为 Map 属性生成模型模式？

对于targets属性，swaggerui 显示 1 行，但没有给出Bar类的模型架构。

如何Bar在 UI 中获取类模型模式？

我在 2014 年 6 月下载了 SwaggerUI，因为我刚刚下载了 dist 文件夹，所以很难找到它的版本。

在这几个月里，我一直在使用 Swagger 来记录我正在使用 Jersey 构建的 REST API，我发现 UI 没有在数据类型列中显示模型和模型架构，用于在我的情况下是集合的主体参数列表，它只显示单词“array”。

似乎这个问题在较新的版本中得到了解决，但是我对代码进行了几次定制，下载新版本对我来说不是一个选项。

我想知道我应该修改代码的哪一部分以使其工作。

我的https://xy/api/swagger_doc.json返回这个：

请注意，路径指向 /ping.{format} 它应该指向 /swagger_doc/ping.json。因此，swagger ui 给了我这个错误：

我可以手动访问 ping.json 表单https://xy:443/api/swagger_doc/ping.json。内容是swagger ui所需要的：

任何想法将不胜感激，以解决这个谜：

I was exploring Swagger and I must acknowledge I'm loving it.

I understand Swagger is primarily for RESTful web services, but I was wondering if we can make it work with SOAP web services as well. May be translate SOAP based web services to RESTful? Or simply call SOAP based services via Swagger UI? Some hack? Has anyone done it?

我正在使用 swagger-ui 尝试标准化 API 文档。我意识到对于使用主体参数并因此需要显示模型和模型架构的动词（GET、PUT、POST 等），架构是在资源级别定义的（宠物商店中的 /pet 或 /store例子）。然而，在我们的 API 中，所需的主体参数会随着动词的变化而变化，最好有一个模型来准确反映这一点。

http://petstore.swagger.wordnik.com/api/api-docs/pet中模型定义的当前版本，模型定义如下：

有没有办法在动词级别覆盖默认的资源级别模型？

我目前已经实现了 Swagger，并且我注意到资源的基本 url 在 JSON 资源文件中是硬编码的，理想情况下，我想让用户能够更改不同 json 动词的基本 url。因此，例如，让他们能够在同一页面上提交来自一个环境的 get 和来自另一个环境的 put，因为我正在使用多个环境，否则他们必须在每个资源中更改 JSON他们想使用新环境的时候。有谁知道这是否可能？

使用内部封装 swagger-ui 的 Restler 3.0.0-RC6，我定义了一个 API 方法，如下所示：

然后我通过 Restler 包含的所有类都addAPIClass扩展了那个 PostgreSQL 类。这意味着当 swagger 运行时，每个 API 都会显示一个 fetchArray 函数。我希望该方法不会出现在 swagger 文档中，因为它实际上并不是 API 的一部分。网站上的其他“事物”也使用该类，因此我无法将修饰符从 public 更改。

从 swagger-ui 的网页中隐藏该方法的正确语法是什么？

我通过 Carma swagger-jaxrs-doclet在maven 构建周期中生成 swagger service.json和其他resource.jsons。之后，我将工件与 swagger-ui 一起部署在 Web 服务器上，我可以查阅生成的文档。这意味着我没有在我的应用程序中部署 swagger bean！

由于 swagger 主要部署在您的 API 实现中，我想知道 swagger-ui 采用哪种方法使文档可执行。它是从 swagger-ui 文档重定向到真正的实现，还是基于 service.json 创建一个模拟后端？我已经读到可以基于 service.json 在 node.js 中创建一个后端，但我不知道如何在网页中执行它。如果可以从网页内，我什至现在都不知道？