问题标签 [swagger-ui]

如何更改 swagger-ui 的路径，使其不加载在 / 但在 /docs/ 一些博客中推荐的简单解决方案是在 webapps 目录中解压缩 swagger-spring-mvc-ui 源。但我寻找一个优雅的解决方案，其中 webjar swagger-spring-mvc-ui 是一个像所有其他依赖项一样的依赖项。

我试图弄清楚如何使用顶级参数，然后在操作级别使用 $ref 来引用在顶级对象中声明的定义。

这是 YAML 的样子，但是当我尝试这个时，我得到一个显示的空参数。任何人都知道正确的语法吗？

我们正在记录应用程序中的所有 API，为此我们正在使用swagger UI

这是它的示例代码

它将请求 URL 生成为

所以它正在为人们生成路径，/people但我们必须将其更改为“/create_people”，所以我们如何实现这个功能。

我们通过更改这里的“路径”来尝试这spec是代码

它正在工作，但它创建了不同的重定向网址，如下所示

这是错误的，我们只需要更改 API 名称而不是请求 URL。

这是图示。

我们正在使用swagger-ui和node.js

我们有许多使用 Swagger 作为文档的微服务 REST API，每一个都作为单独的 web 应用程序实现。有谁知道可以用来为所有这些 API 提供资源管理器或仪表板的产品，以便客户/用户只需转到一个 URL 即可获取我们所有 API 的详细信息。

例如，我们有：

但我们希望能够通过单个 URL 呈现两个文档的组合。

谢谢

缺口

我正在使用 grape-swagger gem 和SwaggerUI的独立安装。我的 API 文档位于http://example.com/api/v1/docs/。SwaggerUI 发现所有资源，但将所有请求发送到http://example.com/v1/foo（URL中缺少“api/”）。这是为什么？

我正在尝试将我的 API 文档分解为多个可以独立编辑的 JSON 文件。我能找到的所有示例都使用 Swagger 1.2 模式，它有一个“api”：{} 对象来分解它。2.0 模式 ( http://json.schemastore.org/swagger-2.0 )似乎缺少这点。所定义的只是一个单一的“路径”数组，它将所有 API 端点捆绑到该单一数组中。这在 swagger-ui 中的效果是有一个单一的“默认”类别，所有东西都被捆绑到其中，我无法告诉将其拆分。

TLDR：如何从 swagger 2.0 模式中的路径拆分操作

我在我的 REST 后端项目中使用以下组件：

• Spring MVC：4.1.2.RELEASE（最新）
• Hibernate4 对象映射器：2.4.3（最新）
• 招摇：0.9.1（最新）
• Javaee-web-api: 7.0 (servlet 3.1)

我正在使用基于 XML 的 bean 配置，并且能够使用 Spring XML 配置文件中的以下内容启动并运行 Swagger 的基本设置：

然后我从https://github.com/wordnik/swagger-ui克隆了 Swagger-UI GIT 存储库，并将 dist 文件夹复制到我的/webapp/docs文件夹中。这样做之后，我可以在以下 URL 上使用基于 JS 的 UI：

问题是没有一个试用按钮起作用，它可用于直接使用 JSON 与您的 REST API 交互。它不起作用的原因是它没有采用正确的基本 url 路径与我的控制器对话：

在网上进行一些研究后，我发现我可能最好采用更灵活的方法，使用https://github.com/martypitt/swagger-springmvc上记录的 SwaggerSpringMvcPlugin 。

这是我的招摇配置类文件：

这是我完整的spring mvc xml文件：

我的web.xml文件中相关部分的摘录：

这是我的swagger.properties文件，由于某种原因根本没有考虑到它。

我在应用程序启动期间得到的堆栈跟踪：

我在某处读到org...RequestMappingHandlerMapping 类型的 No qualifying bean跟踪表明我可能会错过我的 XML 中的 mvc:annotation-driven，但事实并非如此。

我一直在寻找几个小时来找到解决方案，但到目前为止失败了。事实上，在它的基本配置中（使用SpringSwaggerConfig）它的工作率为 90%（除了试用按钮......），这让我还不想放弃 swagger。它看起来真的很酷，是记录 API 的好方法。

因此，如果有人可以帮助我解决这个问题，我将非常感激。大摇大摆的岩石！

亲切的问候，巴特

嗨，我正在使用 swagger UI 在我的 node.js 应用程序中记录 API。我成功配置并且工作正常。

但我现在面临一个严重的问题。

这是我的控制器中的示例招摇代码

在此，我有payload参数，其json格式为

但如果我像过去invalid json一样

然后服务器崩溃了。我必须为这个参数添加验证，所以我怎样才能在这个特定参数上添加验证。

有没有办法在每个字段都有输入的情况下大摇大摆地呈现复杂对象的请求正文？

简单来说，如果我的一个 api 需要一个 Person（假设它只有一个名字/姓氏）作为 @RequestBody，那么为这个 Person 提供招摇的唯一方法就是提供 Person 的整个 json。例如，有没有办法让每个单独的字段分别输入名字/姓氏？

我正在使用 swagger(1.2) 来记录我的 jersey + jaxrs (2.1) api。我使用 swagger-ui 来显示我的 api。对于 http GET 请求，我在 api 端点中有一个查询参数作为 @QueryParam("token")。Swagger 正在显示此查询参数的字段，但是当我单击“试一试！”时 每次我收到它的空值时按钮。

我还用@ApiParam 注释了@QueryParam("token")，但它没有用。谁能解释我在其中做错了什么。查询参数真的大摇大摆地工作吗？