问题标签 [swagger-2.0]

问问题

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.

1560 问题
Newest
Active
Bountied
318
Unanswered
0 投票
1 回答
1193 浏览

json - Swagger 响应头设置

我正在尝试编写一个招摇的 json-schema，响应会产生其中之一

  • png图片
  • JPEG 图片
  • gif图片
  • 细绳

那么，我应该如何设置响应头内容类型以及生成的 MIME 类型？

在此处输入链接描述

0 投票
3 回答
4927 浏览

api - Swagger 是否有能力支持 API 更改历史记录，或者是否有一个开源库可以支持？

我正在使用 Swagger 编辑器生成 YAML/JSON 代码，该代码将在 Swagger UI 中显示我的 API 的详细信息。

我希望我的 API 的使用者能够查看 API 文档的修订历史记录（例如，添加的字段、从“可选”更改为“必需”的字段等）。Swagger 是否支持此功能？

0 投票
1 回答
1922 浏览

java - 无法获取 swagger.json

我有一个 jax-rs spring rest web 应用程序，我想在其中添加 swagger doc。

在我的 web.xml 中，这已经为我现有的 REST API 定义了：

我在我的 servlet 中添加了 Swagger 配置：JaxrsApplication

我还在上下文 xml 文件中添加了 swagger beans：

似乎我的资源扫描工作正常：

但http://localhost:8080/v1/swagger.json不起作用（给出 404）。

我已经尝试了很多案例（在 swagger conf 中使用 v1，没有等），但是缺少一些东西。你有什么想法吗？

我现有的api是这样的：

作品。只是新加入的招摇不。

0 投票
1 回答
797 浏览

authentication - Swagger UI 身份验证

我的招摇 UI 没有将身份验证密钥发送到 API。我认为我已经设置了我的 swagger ui，但是当我检查标题时，它们没有被发送。我有日志告诉我，身份验证密钥被读入，但从未在这些请求标头中发送。

我注意到 clientAuthorizations 字段没有更新并且保持为空。

这是相关代码

谢谢！！

0 投票
5 回答
13708 浏览

odata - 如何记录 OData 端点（swagger、swashbuckle、其他）？

记录 OData 端点的最佳方式是什么？有没有办法使用 Swashbuckle 呢？

0 投票
1 回答
3762 浏览

swagger - Swagger UI - 将 JSON 规范从编辑器读取到 UI 中，无需托管

我试图通过在 Swagger 编辑器中编写文档然后将其加载到 Swagger UI 中来使用 Swagger 记录我的 API。我使用编辑器下载了我的 JSON 文件，然后使用以下命令更改了 UI 中的 /dist/index.html 文件以指向我的本地文件：

我在文件中唯一更改的是使用 spec var 指向我的 JSON 文件，但是当我打开 UI 时，它会显示一个空白 UI 页面，并显示消息“已完成加载资源信息。正在渲染 Swagger UI... “我只想在 UI 的编辑器中显示我在编辑器中创建的文档，而无需托管规范，有什么我遗漏的吗？

0 投票
1 回答
586 浏览

spring-mvc - Swagger 无法正确检测请求参数

给定一个控制器，如：

Spring MVC 让我可以做类似/items/?text=foo&limit=10. 不幸的是，Swagger（或 SpringFox？）认为此端点采用单个“查询”（JSON 对象）参数。我究竟做错了什么？

0 投票
0 回答
1893 浏览

asp.net-mvc-4 - 每个 api 版本的 swagger xml 评论

我使用ASP.NET Web API 2.1 Custom Route Attributes在 Visual Studio 2015 中创建了一个新的 asp.net web api 2 项目。

我正在使用 Swagger (SwashBuckle 5.0) 获取 API 文档，并希望每个版本都有文档，我设法获得了这个文档，但是 swagger ui 显示两个版本的相同 xml 注释。

版本 1 和 2 的 api/view 上的 xml 注释有一些不同之处，这些注释没有出现在 swagger ui 上。

版本 1

版本 2

版本 2

版本 1 控制器

版本 2 API 控制器

0 投票
1 回答
273 浏览

node.js - 使用带有绝对 URL 的外部引用时，swagger-tools 验证挂起

我目前正在按照本指南分解 swagger.json 文件：https ://github.com/swagger-api/swagger-spec/blob/master/guidelines/REUSE.md

我在某处犯了错误，我想使用 swagger-tools 找出我的问题在哪里。当我运行该工具时，它会卡住并且不会产生任何输出。

我正在使用本地主机服务器，我的 $ref 使用绝对 URL 指向本地主机，例如：

我尝试使用文件系统中的文件或由本地服务器提供的文件运行：没有工作。

但是，如果我关闭服务器并尝试从文件系统进行验证，工具会抱怨它无法解析引用，因此以某种方式证明文件已被解析并且 swagger-tools 尝试验证它。

  • 平台：Windows 7 Pro
  • 电源外壳
  • npm --版本：2.11.3
  • 招摇工具--版本：0.9.2
  • 使用 npm -g install 安装
0 投票
2 回答
8997 浏览

swagger - How to group multiple parameters in Swagger 2.0?

Is it possible to group multiple parameters to reference them in multiple routes?

For example I have a combination of parameters which I need in every route. They are defined as global parameters. How can I group them?

I think about a definition like this:

And then reference the whole group in my route:

Is this possible with Swagger 2.0?


12345678910