问题标签 [swagger]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
0 回答
164 浏览

razor - ServiceStack.Swagger 不适用于 ServiceStack.Razor

我已经玩了几个星期的 ServiceStack lib,似乎发现了一个问题。当我从 github 下载 Swagger-UI 的示例项目时,一切正常,直到我添加 RazorFormat 功能。然后,在尝试查看localhost:50001/swagger-ui/index.html(以前可以正常工作)时出现“未找到请求的处理程序”错误。

那么如何同时使用:招摇和剃刀?我试图将 index.html 重命名为 index.cshtml 以使 razor 引擎处理此文件。该页面正在运行,但没有 JS,也没有下载 CSS,所以它没有多大用处。

0 投票
0 回答
182 浏览

routes - ServiceStack.Swagger 仅捕获服务中的第一条路由

这是 ServiceStack.Swagger 的一个问题:

1)从github下载一个例子。2) 转到 HelloText 类(或任何描述对 REST 服务的请求的类,即 HelloImage 或 Hello - 在此特定示例中)。为请求再添加一条路由:

3) 转到本地 swagger-page (localhost:yourport/swagger-ui.html) 或资源页面 (localhost:yourport/resources),您会看到“/abc/”路由被捕获,“/hellotext”被捕获不是

这是错误还是预期行为?如何在多条路线上使用 swagger-ui?还是我必须复制粘贴请求类并将每条路线拆分到它自己的类上?

0 投票
1 回答
1019 浏览

php - 在 API-Explorer/Swagger 中描述响应对象

我正在使用Restler 3 的 API-Explorer,它是Swagger-UI的一个分支,我想知道是否有人找到了一种有效的方法来记录/描述 API 返回的响应 JSON 对象。显然,当您以交互方式试用 API 时,其中的一些——以“字里行间”的方式——是可用的,但我想要一些更详细地指示响应结构的方式。有没有人为此提出任何建议?

0 投票
4 回答
91307 浏览

swagger - 如何在 Swagger (OpenAPI) 中发布文件?

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

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

NS_ERROR_XPC_BAD_OP_ON_WN_PROTO:对 jquery-1.8.0.min.js 中 WrappedNative 原型对象的非法操作(第 2 行)

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

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

0 投票
4 回答
2166 浏览

php - 找不到 resources.json

出于某种原因,当我使用 Restler 的 API Explorer(Swagger UI 的一个分支)将我的 API 部署到生产环境时,它在我加载时给了我一个一般的 404 错误:

当我更明确地说:

它加载页面的框架,然后在标题下方以红色文本报告“404:未找到../resources.json”:

在此处输入图像描述

我相当肯定,当相同的文件在本地工作时,环境会出现一些问题。我还检查了目录中的 .htaccess 文件,/api/explorer它看起来对我来说是正确的:

任何帮助,将不胜感激。

0 投票
1 回答
238 浏览

restler - API Explorer 中缺少响应和输入信息

我正在使用最新版本的 Restler v3 (commit 0d79cd8),但我遇到了一些问题,我的基于 Swagger 的 UI 看起来与示例中的相同。我注意到的两个问题是没有显示变量类型和@return 对象。

在 Restler 网站上,这是这两种工作的一个很好的例子:

例子

相反,在我的Actions课程中,我得到了这个:

在此处输入图像描述

然而,正如您从类的定义中看到的那样,指定了类型信息和响应对象:

我对 ActionList 类的定义是:

0 投票
3 回答
2528 浏览

c# - 如何使用 Swagger/ServiceStack 指定响应类并返回状态码

是否可以使用ServiceStack.Api.Swagger v3.9.33来描述 API 操作的响应和返回的状态代码Swagger?也许通过响应类/属性等的属性装饰。

就像宠物商店 API 中以下示例操作的突出显示部分一样:( http://petstore.swagger.wordnik.com/ )

在此处输入图像描述

我只能看到 HTTP 方法和请求 DTOS 可以在https://github.com/ServiceStack/ServiceStack/wiki/Swagger-API上进行修饰,并且快速浏览代码看起来可能还不支持,https://github。 com/ServiceStack/ServiceStack/tree/master/src/ServiceStack.Api.Swagger

0 投票
1 回答
191 浏览

restler - REST 请求在 Explorer 之外不起作用

我正在使用 Restler 的 API Explorer(Swagger UI 的一个分支),当我在那里测试服务调用时它工作正常,但是当我将相同的 URL 剪切并粘贴到 Chrome 的高级 REST 客户端时,我收到“403 Forbidden”错误。这个怎么可能?是否有某种必需的标头参数需要随请求一起传递?

以下是屏幕截图:

在此处输入图像描述

在此处输入图像描述

0 投票
0 回答
571 浏览

mod-rewrite - 重写和 Restler

我正在努力解决Luracast Restler和 Restler 的API ExplorerSwagger UI的一个分支)的重写问题。我有一个在 OSX 机器的本地主机上运行的完全正常工作的开发环境,但相同的文件(包括 .htaccess 文件)在我运行 Ubuntu 的预生产盒上不起作用。在这两种情况下,我都可以访问 httpd.conf 文件,并倾注于它们以寻求某种答案。诚然,mod-rewrite 对我来说仍然是某种形式的黑暗魔法,所以我真的很想从其他人那里得到一些建议。

我已经在 httpd.conf 的以下条目中打开了两种环境中的日志记录:

这会在 pre-prod 中产生一些有趣的结果,这些结果对于受过训练的眼睛甚至可能会有所启发。如果我打电话http://website.com/api/explorer,我会得到:

有趣的是——对我来说同样无法解释——在我的本地环境中调用相同的 URL 根本不会给我任何日志记录(有一个零字节日志,所以我相信我已经在 httpd.conf 中正确配置了它)。我原以为在本地环境中——Restler 工作的地方——会有一个日志条目用于转换/api/explorer/api/explorer/index.html.

中的 .htaccess 文件/api/explorer如下所示:

其中/api是:

更新

根据@faa 的建议,我添加了 .htaccess 文件的基本路径:

并且还将[QSA,L]规则的参数更改为[QSA,L,DPI]. 日志现在说:

令我困惑的是——如果我没看错的话——是:

  • 正确地从 '' 重定向到 'index.html'
  • 但随后第 2 行“尝试替换前缀”似乎完全多余
  • 然后为什么!#?!它是否使用“/var/www/html/api/explorer/index.html”进行内部重定向?

如果我这样做,ls -l /var/www/html/api/explorer/index.html我会得到:

显然这个文件存在,并且 apache 提供这个内容的权限很好。

更新 2

还值得注意的是,我在根目录安装了 Wordpress,它有一个 .htaccess 文件,如下所示(顺便说一句,这是默认的 WP 加上流行的 W3 Total Cache 插件):

0 投票
1 回答
1427 浏览

servicestack - ServiceStack SwaggerUI 路由位置

ServiceStack 的 SwaggerUI 实现的文档说明

默认配置要求 ServiceStack 服务在“/api”路径下可用。

但我的 api 在根目录。有没有办法改变 SwaggerUI 的外观?