问题标签 [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 投票
2 回答
24736 浏览

dictionary - Swagger HashMap 属性类型

有没有办法在模型部分定义 HashMap 或 Generic Object 类型?我有一个返回产品的 REST 服务,这些产品可以有不同的选项。options 属性基本上是一个 HashMap,其中 id 是选项名称,其值是选项值。

0 投票
2 回答
3646 浏览

php - Swagger-PHP 和 CakePHP

我正在尝试在我的 CakePHP 项目中使用Swagger-PHP ,但遇到了一些问题。有没有人设置这个?你有什么建议吗?我已经通过 Composer 成功安装了 swagger-php,它已加载到我的控制器中(见下文)。我正在尝试通过 Web 视图呈现规范,但我不太确定为什么没有填充注册表,或者是否需要填充。

以下是 ApiController.php 内部

结果

所以,基本上 $swagResults 是空的,我猜这不应该是,对吧?

0 投票
1 回答
2588 浏览

c# - 使用 Swagger.NET,如何详细描述返回值?

我有一个返回对象的 Web API REST Web 服务。我已经安装了Swagger.NET以及 Swagger UI。我希望 Swagger UI 列出从 Web API REST 方法返回的对象内的字段。这可能吗?

从 Swagger 文档中,Swagger.NET 使用 ApiExplorer 收集有关我拥有的 Web API 端点(扩展 ApiController 的类)的信息。此外,Swagger.NET 查看 .NET 文档注释(使用 '///')。我不确定如何描述这些对象的内部结构。

有任何想法吗?

谢谢。

0 投票
1 回答
1641 浏览

c# - 使用 ServiceStack 的 Swagger UI 传递标头

我正在尝试使用 ParameterType = "header" 的 APIMember 属性在我们的 SS 服务中添加标头。

除了没有添加到 RequestContext 的标头之外,一切似乎都在工作。希望它支持标题。如果是这样,如何以及有没有办法在 Get 查询或路径中不允许该标头属性?

我究竟做错了什么?

帮助表示赞赏!

谢谢,纳克

0 投票
3 回答
1015 浏览

node.js - Swagger + Node.js 的异步验证功能

所以,我使用的是 Node.js + Swagger + MongoDB。

我正在尝试验证所有请求是否都带有有效的 auth_token,这是存储在 mongo 上的用户的值。我的问题是 Swagger 支持的验证器需要返回 true 或 false,但由于我必须检查 Mongo 以验证身份验证令牌,因此整个验证变得异步。

以下是您需要的代码:

我该如何解决这个问题?

0 投票
2 回答
19064 浏览

php - Swagger-PHP 用于为 Swagger-UI 生成 JSON 文件

我正在尝试使用 Swagger-PHP 生成 JSON 文件,以便我可以将它与 Swagger-UI 一起用于自动文档。

我尝试了链接:- https://github.com/zircote/swagger-php

我还尝试使用http://zircote.com/swagger-php/installation.html上的文档

但我的运气不好,我无法实现它。

我能够正确安装作曲家。Swagger-PHP 的捆绑包也已正确安装。

但问题是我无法使用/理解他们提供的测试示例。

因此,如果有人解决了它,请帮助!

提前致谢 !!

0 投票
2 回答
1314 浏览

php - Restler:作为参数的复杂对象类型

你好 Restler 朋友们,

我目前正在尝试切换到 Restler 作为我们的主要 Rest-Framework。真正促使我做出决定的是大摇大摆的合规性。我发现为不断增长的系统提供一个很好的自动生成文档非常重要。

所以,我的问题是我似乎无法找到一种方法来使用“复杂对象”作为帖子参数,如此处 swagger 中指定的那样:https ://github.com/wordnik/swagger-core/wiki/Parameters 。

当然,您可以从“post assoc 数组”中检索所有内容,然后针对对象结构进行验证,但这不会记录在案,客户也不知道他期望什么结构。因此,我将不得不编写一个规范。用手...

例子 :

这将简单地作为未定义的“对象”放在 resource.json 中,而不是作为链接到 Account 对象的“复杂类型”(顺便说一句,这对于返回的对象非常有效)

资源.json

我错过了什么还是没有实现该功能?

提前感谢您帮助我!

更新:我设法直接从 post 方法中直接获取序列化对象,但我认为这是不可能的。这并不能解决自动文档问题,但仍然非常有价值。

0 投票
1 回答
1018 浏览

swagger - 大摇大摆的泛型列表具有类型“任何”而不是适当的类型

我正在使用 swagger-jaxrs_2.10.0 版本 1.2.3(刚刚从 1.2.2 升级,结果相同)

如果我有这样的课程:

Swagger 将其报告为:

我需要什么特定的魔法才能使“任何”变成适当的类型?

0 投票
1 回答
1818 浏览

swagger - 从 json 文档响应中删除对象的某些属性 Swagger for REST api

嗨,我正在使用 swagger 来记录我的 RESTful Web 服务。想知道有没有办法从 json 文档响应中删除对象的某些属性?我的意思是,swagger 为我的方法参数对象和响应模型(例如注释、defaultValue、allowableValue、internalDescription 等)提供了很多属性,这些属性对我来说不是必需的,并且由于响应可读性不强而为空

对于方法参数:

-================================================== ==============================

对于响应模型类

0 投票
2 回答
2310 浏览

servicestack - 服务堆栈:没有 /swagger-ui/index.html

我在没有 IIS 的独立模式下将 ServiceStack 用于我的自定义服务。

我想为我的服务添加文档/metadata。我想试试 Swagger 插件。

我已将插件命令添加到我的配置中

现有服务继续工作,但尝试访问

/swagger-ui/index.html

给出未找到的错误。是否有其他步骤未明确记录在

https://github.com/ServiceStack/ServiceStack/wiki/Swagger-API

我必须自己实际设置此页面吗?如果是这样,怎么做?