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

flask - 将 Swagger 与 Flask 一起使用

有没有办法使用Swagger在Flask中生成 RESTful API ?

0 投票
1 回答
13508 浏览

rest - 如何将 swagger-ui 与部署在 eclipse 上运行的 tomcat 中的服务一起使用

我有一个 REST api 正在运行,http://localhost:8080/MyService并且可以在 .swagger 上看到由 swagger 生成的 JSON http://localhost:8080/MyService/api-docs。在 Eclipse 的 Servers 项目中,我修改了 web.xml 以包含 Cors 过滤器:

但是当我将 swagger-ui(从文件系统加载到浏览器中)指向时http://localhost:8080/MyService/api-docs,我收到以下错误:

无法从服务器读取。它可能没有适当的访问控制来源设置。

0 投票
3 回答
7010 浏览

c# - Swagger.NET MVC API 异常

我一直在寻找提供自动生成的 API 文档的不同选项,而 Swagger 似乎就在那里。

然而,当我第一次尝试这个时,我在启动时遇到了异常。

运行 Visual Studio 2013。
创建新的 Web API 项目。
使用包管理器,运行:

确保我们启用了 XML 文档,我们得到了这个异常:

有其他人知道我们缺少的步骤吗?我们发现并遵循了这个:
https ://github.com/Swagger-Net/Swagger.Net/wiki
https://github.com/Swagger-Net/Swagger.Net/blob/master/README.md

0 投票
1 回答
798 浏览

html - 在网址显示json数据

我有一个我认为是关于在网址上显示 json 文件以便它可以被 Swagger UI 识别的简单问题。

地址http://petstore.swagger.wordnik.com/api/api-docs显示 json 数据,并允许将文件保存为 .json 文件。我无法使用 html 复制它。这是我尝试过的:

文本会显示,但保存页面不会将其保存为 json 文件。

我应该补充一点, http: //petstore.swagger.wordnik.com/api/api-docs是一个目录,http ://petstore.swagger.wordnik.com/api/api-docs/pet 也是 json 数据。

0 投票
1 回答
518 浏览

c# - Servicestack - 请求 DTO 的多个 IReturn

是否可以有多个IReturn<>请求 DTO?

例如以下路线:

根据请求方法,我想要另一个IReturn. Post-Put-Delete Request 仅在请求成功时才应返回确认:

但在 GET 请求中,我想要一个:

如果有办法在 Swagger Api/元数据页面中反映这一点,那也很好。目前只显示第一个IReturn

这是可能的还是为每个不同的人创建一条路线会更好IReturn

0 投票
1 回答
8224 浏览

curl - Generate cURL command of swagger

We have an API documentation generated by swagger running here and I asked myself how to let swagger generate an additional curl command line example for the current endpoint/method. Is that possible without hacking into skala?

0 投票
1 回答
2215 浏览

rest - Swagger 响应类 Map

我有一个返回的 REST API,本质上是一个 (String, Object) 的 Map,其中 Object 是

  1. 一个自定义 bean(比方说类 Bean)或
  2. 元素列表,所有类型为 Bean

在 JSON 中,这很好地转换为:

通过 swagger 注解,有没有办法将这种动态 Map 指定为响应类?

谢谢

0 投票
1 回答
2801 浏览

django - Django Rest:如何使用 {pk} 禁用 POST api

如何[POST] /api/contact/{pk}/使用 Serializer 摆脱 api?(去掉第二个API)我的序列化器定义如下:

我的 ViewSet 如下:

Django REST Swagger UI

0 投票
0 回答
534 浏览

javascript - Servicestack-SwaggerUI 在 IE<10 上因未找到方法“defineproperty”而崩溃

我在 Servicestack v4.07(许可)应用程序上使用 SwaggerUI 来公开 REST 规范。

一切都适用于 Firefox 和 Chrome,但是当我尝试使用 IE9 或更低版本打开 swagger 索引时,它崩溃了,只显示页面标题,因此没有列出任何服务。

实际上我可以重现这一点,但即使在 swagger 演示网站http://petstore.swagger.wordnik.com/

当我用IE9打开它时,它会因为一个(可能的)已知问题而崩溃:https ://github.com/wordnik/swagger-ui/pull/204 。

当我用IE8打开它时,提琴手告诉我 Object 类没有这样的defineProperties方法(从shred.bundle.js引发的异常)

有人知道这些问题吗?

0 投票
1 回答
1441 浏览

spring - 如何使用 Spring 3.1.2 应用程序设置 swagger-springmvc 0.6.5

我正在尝试在 Spring 3.1.2 项目中使用 swagger-springmvc 0.6.6。但是当我将应用程序部署到 Tomcat 时,它失败并出现异常。

我使用的版本似乎有问题。swagger-springmvc 还引入了与 Spring 3.1.2 jar 冲突的 Spring 3.2.4 jar。

错误:

该类org.springframework.cache.ehcache.EhCacheFactoryBean在 Spring 3.1.2 和 Spring 3.2.4 中都可以找到。

当我尝试在我的本地 smachine 中运行该应用程序时,它的运行没有问题。

有人可以帮我解决这个问题吗?