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

spring - 使用 Swagger 的 Spring REST API 文档

我正在寻找可以帮助我生成 RESTful API 文档的工具。我的服务器是用 Java 编写的,并使用 Spring MVC 框架。我的服务器中没有 VIEWS。这是一个 100% 的 RESTful 服务,它所做的只是消耗 JSON 并输出 JSON。

我想知道Swagger是否与 Spring 注释兼容?

0 投票
2 回答
32899 浏览

rest - 使用静态文档大摇大摆

我希望使用 Swagger 来记录我的宁静界面。问题是我不想通过注释我的代码来自动生成我的文档。基本上我不想将我的内部数据模型耦合到接口公开的虚拟数据模型。看来我可以让我的服务器提供一个 Resources.json 文件,然后为每个资源处理程序提供一个相应的 JSON 文件。然而,当我尝试这个时,我在尝试定义 JSON 正确语法并提供正确的 HTTP 标头响应字段时遇到了很多小问题。

有没有人以这种方式使用过 Swagger?有人有一些文档或示例吗?我能找到的一切都围绕着简单地使用客户端库为你生成东西。

0 投票
1 回答
1809 浏览

swagger - Swagger UI 当前是否支持模型?

Swagger Spec 提供了描述模型的规定。

但是,现有的 Swagger-UI 项目似乎没有使用它或显示模型。查看Petstore Demo,我看到提供了一个模型,但看不到它显示。

我错过了什么吗?还是只是还不支持?

0 投票
1 回答
577 浏览

json - 记录私有 Web API

我们为项目内部使用设置了一个 Web API。我正在寻找一种记录我们 API 的好方法。我已经在网上搜索并找到了

这些工具读取可以自动创建的 JSON 文件,例如用于 Java。我们的 API 已经增长,我喜欢手动创建 JSON,而不是在文本编辑器中手动创建。是否有工具或前端可以减轻手动创建描述性 JSON 的负担?

另一方面,对于 Web API 的文档,有哪些值得推荐的工具?

0 投票
1 回答
12309 浏览

swagger - Swagger UI 错误:无法获取 API 列表

我正在使用Swagger记录 REST Web API 。我已经下载了 petstore 示例。它由resources.jsonwhich 引用pet.json和组成user.json

但即使在将原始文件上传到我的网络服务器之后,Swagger UI 也会告诉我:

你能说出是什么原因导致 Swagger 找不到我的 json 文件吗?

0 投票
2 回答
388 浏览

playframework - playframework 1.x 的招摇在哪里?

该模块仍在播放站点上列出,链接已失效,但该项目非常活跃。有没有办法在 play 1.x 中获得该模块或获得 swagger 支持?

0 投票
1 回答
418 浏览

rest - 无法在 Swagger 中使用 REST 注释

我已经下载了 swagger ui 并在本地进行了实验。它在 "path"、"body" 和 "query" 等场景中运行良好。但是我的大多数用例都使用了其余注释。

即 /resourcePath/;tags 用于检索特定资源标签的 URI。

当我尝试这个时,添加分号时 UI 会变得混乱,并且排序的 UI 格式不正确,并且不能超出此范围。

那么这是一个已知的限制吗?有没有办法实现这个目标?感谢对此的任何输入..

0 投票
2 回答
5052 浏览

java - 使用 Swagger 的 CXF REST API 文档

根据 Swagger 的教程,似乎swagger只支持Jersey框架(参见https://github.com/wordnik/swagger-core/wiki/java-jax-rs

有人有使用CXF JAX-RS实现的经验吗?你能在这里分享你的建议吗?

0 投票
1 回答
1099 浏览

documentation-generation - 跨多个浏览器使用 Swagger

谁知道这个问题?Swagger 似乎无法支持 IE。我在 Tomcat 中部署了 Swagger 示例,如下所示。该示例在 Google Chrome 和 Firefox 中运行良好。 https://github.com/wordnik/swagger-core/tree/master/samples/no-server

但该示例无法在 IE 中正确显示。URL 总是被定向到 tomcat 的索引页面。我尝试将“localhost”更改为 IP 或主机名,但它仍然无法在 IE 中运行。swagger 不能支持 IE 吗?它是一个错误吗?

谢谢你的帮助。

0 投票
2 回答
4272 浏览

jersey - 使用过滤器引导 Jersey 会导致 Swagger 失败

在我的应用程序中,web.xml我最初将 Jersey 配置如下:

这似乎工作得很好,我可以使用 swagger-ui 来浏览我的注释端点的文档。

但是,我想在我的应用程序中“嵌入”swagger UI,以便浏览文档的方式随之而来。<url-pattern>考虑到我的 Jersey servlet,我遇到了为 swagger-ui 提供静态内容的问题。显然,我可以将其更改为,例如,/api/*但这在我的情况下实际上是不可取的。

我在这里读到,Jersey 可以配置为作为过滤器而不是 servlet 运行,然后您可以为要从 Jersey 处理中排除的 URL 指定一个参数:

这本身也很好用。但是当我把大摇大摆带入组合时,事情就开始出错了。具体来说,将com.sun.jersey.config.property.packages参数引入基于过滤器的配置,就像我在 servlet 配置中那样:

导致过滤器无法启动,并出现以下错误消息:

我被困在这一点上。任何人有任何建议/指针?