问题标签 [swagger-ui]

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 投票
1 回答
4121 浏览

swagger - 带有 Jax Rs 资源的集合(列表)输入参数的 swagger ui

如何配置 swaggerui 以显示具有集合输入参数的 JAX-RS 资源的正确参数数据类型?

下面是一个示例 groovy JAX-RS 资源。它的输入是类型List<User>

在 swagger UI 中,我看到填充了空类型的 List 而不是User. 它适用于输出参数。使用ApiOperation注释,我可以指定响应类型。

对于输入参数,如何在 swagger UI 中查看用户模型架构列表? 在此处输入图像描述

0 投票
1 回答
835 浏览

servicestack - ServiceStack + Swagger-UI 如何显示属性是必需的还是可选的?

如何将模型上的可选/必需信息显示为黄色突出显示?

在此处输入图像描述

0 投票
1 回答
492 浏览

rest - Swagger-Springmvc:在 JSON 中获取未知字段

我有一个 REST API,我配置如下

abc中的一个方法注解如下

我使用 Swagger UI 生成的文档显示了找到的所有内容,但是无法为我的模型类 Account 生成模型 json。除了用户定义的“共享”类数组之外,帐户还由几个变量组成。它由另一个用户定义的类用户组成。

Account类注解如下:

为模型响应和请求显示生成的文档

请指导此处可能出现的问题。如何显示 json 版本的 Account 对象。谢谢你。

0 投票
1 回答
639 浏览

java - Swagger API 控制台在 WSO2 中不起作用

我正在使用 WSO2API Manager 1.7.0,我已经发布了 API,但我无法通过 Swagger 从 API 控制台部分的 API Store 调用它,它没有传递授权参数,并且调用总是被拒绝OAuthenticator 中的 API 管理器说密钥是 null ,尽管在 UI 中指定了标头,即使使用 youtube 的示例 API,我也无法通过 API 控制台成功调用。

API Manager 拒绝调用,因为授权标头未通过

从 swagger 调用 API 并传递授权详细信息

0 投票
1 回答
329 浏览

c# - 将 swagger.net 下载到 web Api 项目后,我收到错误,因为程序集生成失败

我已经从 Nuget 包中为 .Net 安装了 SwaggerUI,并尝试使用 swagger 测试 web api 方法。但我得到低于编译时错误。

当我将签名属性的解决方案设置 从选中更改为未选中时,我没有收到此错误。现在我不想更改对解决方案设置的签名属性所做的任何设置并修复此错误。有人可以帮我解决此错误吗?

0 投票
1 回答
4066 浏览

asp.net-web-api - 标有 JsonIgnore 的属性仍显示在 Web API 的 Swagger UI 文档中

我正在使用将 swagger 与 Web API 项目集成的 Swashbuckle 包。我想隐藏文档中标记为已忽略的属性。我尝试使用不同的方式,例如 IgnoreDataMember、DataContract 和 DataMember、JsonIgnore 或 XmlIgnore,但似乎没有任何东西可以与 swagger ui 一起使用。

但是,在默认 API 文档中,它按预期工作。这就是我的模型的样子:

0 投票
1 回答
237 浏览

oauth - 我们在哪里可以在 WSO2 AM 1.7 中指定 API 资源的 Auth Type

我们在哪里可以在 WSO2 AM 1.7 中指定 API 资源的 Auth Type

在文档https://docs.wso2.com/display/AM170/Adding+Documentation+Using+Swagger中,它说可以通过添加资源来定义它,但这些选项完全不同。

我在 AM 1.7 有什么

什么文件说

0 投票
1 回答
1475 浏览

swagger-ui - Swagger UI 是否支持@ModelAttribute?

@ModelAttribute我已经为 REST Web 服务配置了 Swagger,它运行良好并使用干净的文档获取我的请求、响应参数,但是在使用注释时无法显示模型架构

我必须做些什么才能让 Swagger 接受这样的注释@RequestBody吗?

0 投票
0 回答
928 浏览

java - 大摇大摆玩 2

有没有人尝试将 swagger 与 play 2 一起使用。我有 play 2 java 项目,我正在尝试将 swagger 与它集成,但没有任何运气。我使用此依赖项安装了软件包:

但我不断从路由文件中收到此错误:

知道如何解决吗?

0 投票
3 回答
4664 浏览

python - 无法使用 Flask 蓝图和 Swagger UI 获取 API 规范

因此,按照烧瓶蓝图(https://github.com/rantav/flask-restful-swagger/blob/master/examples/blueprints.py)的 swagger ui 使用示例,我有以下代码:

但是,当我尝试访问 api 规范文档时,无法找到该 URL。我试过了...

...所有这些都返回 404。我还尝试创建没有蓝图的应用程序,创建文档

反而。完成此操作并且不涉及任何蓝图后,我可以在以下位置找到文档

那么,我是否使用蓝图错误地创建了我的应用程序,或者我只是没有点击正确的 URL 来访问文档?