问题标签 [swagger-ui]

我正在使用 Swagger 来记录我的 REST 服务。我的一项服务需要上传 CSV 文件。parameters我在 JSON API 定义的部分中添加了以下内容：

现在我在 Swagger UI 页面上看到了文件上传选项。但是当我选择一个文件并单击“试用”时，我收到以下错误：

NS_ERROR_XPC_BAD_OP_ON_WN_PROTO：对 jquery-1.8.0.min.js 中 WrappedNative 原型对象的非法操作（第 2 行）

该页面正在不断处理，我没有得到任何回应。

有什么想法可能是错的吗？

I'm trying to use SwaggerUI, but I'm having some problems.
When I call http://mysite.com/api/swagger I get this:

But, when I call http://mysite.com/api/docs/V1.Foo or http://mysite.com/api/docs/V2.Foo I get this:

It look like I'm calling my API, but I'm trying to get the API documentation.

All my controllers implement System.Web.Http.ApiController.

This is my WebApiConfig:

And this is my IHttpControllerSelector implementation (VersionControllerSelector):

SwaggerActionFilter doesn't get my request when I call http://mysite.com/api/docs/"some-controller".
If I use SwaggerUI in another Solution without versioning, I'm able to get all documentations.

I know that maybe my versioning selector is wrong, but I dont't know what is wrong.

我正在尝试在我的 ServiceStack 项目中实现 ServiceStack.Api.Swagger NuGet 包，但是 /swagger-ui/lib 文件夹缺少 Index.html 中指示的 jquery 和 handlebars 脚本文件。

我能够缓解 jquery 问题，但车把问题阻碍了我。如果我只是添加 handlebars-1.1.0.js 并在 Index.html 中引用它，我会得到：

模板是使用比当前运行时旧版本的 Handlebars 预编译的

我在这个包应该如何工作方面遗漏了一些东西吗？我希望通过有限的配置来启动和运行它，但我已经花了很多时间试图让 Index.html 在不引发脚本错误的情况下呈现。

我正在为 ServiceStack 3.9.59.0 使用 Swagger 插件。我的 ServiceStack API 中有一些端点，例如 /selfchecknode，我不想显示在 Swagger UI 中。

是否有一种声明性方式（可能通过合同属性），我可以使用它来隐藏特定端点以使其不显示在 Swagger 中？

我用 github 上提供的示例和想要自己运行代码的任何人的下拉框下载链接重新问了这个问题：Swagger not working on a self hosting ServiceStack Service

我的 servicestack JSON 服务在我的网站解决方案中运行，位于“/api/”路径下，但现在我想拆分该服务堆栈部分并将其作为自托管 Windows 服务运行。我的问题是，我自己和其他开发人员发现 Swagger 插件对于测试目的非常有用，但现在它是自托管的，看起来 HTTPHandler 仅用于处理服务路由，而纯 HTML 不起作用。

我该如何解决？

网址：http://localhost:8081/Swagger-UI/Index.html

回复 ：

已安装 Nuget 包：

@marfarma 的更新

我的 app.config 文件里面没有任何与 ServiceStack 相关的内容......

程序.cs：

配置方法：

更新 2：

1.) 删除了上面删除 html 和 csv 的插件部分

2.）在包管理器（nuget）中运行以下内容：

仍然没有找到处理程序。

marfarma 向我指出的这个问题（ServiceStack: No /swagger-ui/index.html）中的建议表明我可能没有'swagger-ui' html 和javascript。我愿意。

似乎自托管服务堆栈仅“处理”指定的路由，当我要求自托管服务提供 swagger html 和 javascript 时，我收到上面的“未找到请求的处理程序”错误。

当我在我的自托管服务中访问 /resources 地址时，它显示了预期的页面和数据（表明 swagger 插件正在正确地做它的事情），但是当我从文件系统加载 swagger html 和 javascript 时（不是 'served ' 通过我的服务），并为其提供有效的资源 url，我得到“无法从服务器读取。它可能没有适当的访问控制源设置。”，这似乎是一个 CORS 问题，但我'已经在我的服务上启用了 cors（它似乎是 Swagger UI 代码的问题），swagger-ui 向我的自托管服务发送作为“OPTIONS”（而不是 GET 或 POST）发送的请求，并且选项请求失败:(

我不确定这是否是 Swagger JavaScript 或生成的 Swagger JSON 的错误，但似乎当我将 SwaggerUI 指向单个资源（即 /resource/MyResource 与 /resources）时，模型似乎没有被正确解析。当我通过“/resources”url一次性查看所有资源时，模型正确显示为响应类和输入（正文类型）参数。当我将 url 切换到单个资源时，所有模型都消失了。输入参数的名称和描述以及整体“方法签名”仍然存在。Swagger Petstore 演示似乎不会发生这种情况（尽管被授予，但它使用的是更新版本的 Swagger）。就 Swagger 相关的 API 属性而言，我应该做些什么来帮助解决这个问题？

编辑

作为一种解决方法，我对我的服务使用最新的 SwaggerUI（它基于 Swagger 1.2 规范，但我没有更改任何 ServiceStack.Api.Swagger 代码来支持它）。我不得不通过修改 swagger.js 来强制 SwaggerUI 以 JSON 格式请求资源以添加“接受：'application/json'”，但是一旦我这样做了，它似乎在指向单个资源时工作。因此，这可能只是将 ServiceStack.API.Swagger 中的嵌入式 SwaggerUI 更新到最新版本的问题。

按照此 URL 处的代码示例：

https://github.com/ServiceStack/ServiceStack/wiki/Self-hosting

我创建了一个空解决方案，将上面的 C# 代码粘贴到“program.cs”中并运行以下 nuget 命令来导入所需的库和代码文件：

该服务运行良好，大张旗鼓的元数据正确传递，但是在尝试访问时/swagger-ui/index.html出现错误'Handler not found'。

我通过 dropbox 分享了我的基本示例代码：

ServiceStackSelfhosted.zip (2.5 MB)

ServiceStackSelfhosted_stripped.zip （8 Kb，但需要运行 nuget 命令）

我一定很愚蠢，但我无法弄清楚 [Api] 属性的使用实际上对ServiceStack 的 SwaggerFeature做了什么。

不标记 [Api] 似乎不会影响 api 是否出现在 Swagger 中，并且在使用它时我找不到任何地方呈现的描述，例如 [Api("Service Description")]

我的用法是这样的：

在 Swagger-UI 中，结果在展开时显示在页面上：

我想使用 swagger 来记录我们的 RESTful API。我们的 Jersey 课程将从 mule 流中消耗。要使用 swagger 记录我的 API，我需要使用此处提到的 servlet 配置 - https://github.com/wordnik/swagger-core/wiki/Java-JAXRS-Quickstart

由于 Jersey 类部署在 mule 中，因此没有 web.XML。

如果您知道如何使用 Mule 配置 swagger，请告诉我如何操作。我非常感谢您的反馈和建议。

我有一个要记录的 REST 服务，其中一些接受简单的数组，例如：

我如何在 Swagger 模型部分对此进行描述？我只能像这样创建“命名数组”

但它描述了这样的数据：