问题标签 [openapi]

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 回答
910 浏览

swagger - Swagger / OpenAPI:链接到带有编码空格的标签

我有一个带有标签的 Swagger API 定义:

我想在下面的描述中有一个指向这个标签的链接,所以我使用 GFM 语法对空间进行编码,如下所示:

但是,该链接不起作用。如果标签没有空格,那么它可以完美地工作。有没有办法可以使用名称中带有空格的标签并链接到它们?

0 投票
2 回答
9681 浏览

java - 从 Swagger/OpenAPI 生成 Spring MVC 控制器

有没有办法从 Swagger/OpenAPI 规范生成控制器 Spring MVC 代码?

我知道 Swagger 可以从现有的 Spring 代码中生成,但这可能反过来吗?

0 投票
3 回答
89328 浏览

swagger - 如何在 OpenAPI/Swagger 中指定字段是可选的还是必需的?

我如何在 OpenAPI/Swagger 中定义一个字段是可选的还是必需的,默认值是什么?

0 投票
1 回答
107 浏览

swagger - editor.swagger.io 和 swagger project create 命令创建的项目结构的区别

有没有人尝试通过 editor.swagger.io 使用 YAML 文件生成项目骨架?然后在不编辑项目结构的情况下对其进行单元和集成测试。
我尝试了命令行和 editor.swagger.io 来创建 swagger 项目,但项目结构不同且不一致。看看下面的一个。
editor.swagger.ioimage

我通过使用 editor.swagger.io 得到这个项目结构,创建服务器代码,节点 js。

下面是我在使用“swagger project create prjName”命令时得到的。
招摇 cli

为什么它们不同?有没有办法让它在这两种方式上保持一致?

0 投票
3 回答
11744 浏览

swagger - 如何在 OpenAPI (Swagger) 中为同一路径定义不同的查询参数?

我正在使用 Swagger Codegen 启动 REST 服务。我需要对不同的参数有不同的响应。

示例:<baseURL>/path可以使用?filter1=or ?filter2=,并且这些参数应该产生不同的响应消息。

我希望我的 OpenAPI YAML 文件分别记录这两个查询参数。这可能吗?

0 投票
1 回答
11790 浏览

typescript - 如何使用 Swagger Codegen TypeScript Fetch Client

有没有人成功使用 Swagger 代码生成器创建了一个可以在浏览器中使用的 TypeScript Fetch 客户端?我正在尝试在使用 TypeScript 的 React 应用程序中使用生成的 API 客户端。

尽管我已经成功生成了一个客户端(即 api.ts 文件),但我对它以以下导入开始的事实感到困惑:

虽然我可以成功找到 isomorphic-fetch 和 core-js 的 TypeScript 类型(即@types),但我找不到 querystring 和 url 的类型。结果,我得到[ts] Cannot find module...querystringurl还有assign进口。

这个客户端实际上不打算在浏览器中使用吗?否则,任何人都可以就我在这里可能做错的事情提供任何建议吗?

提前感谢您的帮助!

0 投票
2 回答
16216 浏览

swagger - 如何在 OpenAPI (Swagger) 中指定多个主机?

现在我的 OpenAPI 2.0 YAML 文件只有一个主机 URL:

我可以像这样使用多个主机吗?

0 投票
1 回答
3580 浏览

rest - 如何将 Swagger OpenAPI 规范添加到 Spring Boot 项目?

我发现这个项目https://github.com/OAI/OpenAPI-Specification 据我了解,我们可以在文件中编写文档.json/.yml。此外,我可以在http://editor.swagger.io/中看到它可以呈现到.html文件中。

我的问题是 - 如何从文件生成静态.html页面?.json/.yml有没有关于spring boot应用程序的教程?我应该以某种方式将.json/.yml文件设置为招摇配置并获取.html带有文档的文件吗?

0 投票
1 回答
7393 浏览

swagger - 如何在 OpenAPI (Swagger) 中指定多个 404 原因?

我正在为嵌套资源(属于交付的内容)定义路径。如果客户端收到 404,则可能是因为未找到交付 ID,或者交付不包含任何指定类型的内容。

如何使用 OpenAPI (YAML) 对其进行建模?

我现在有这个...

...但是当我从 Swagger 编辑器中保存 JSON 时,它会删除除最后一个响应之外的所有 404 响应(“交付不包含任何文章”)。

0 投票
1 回答
868 浏览

yaml - 招摇未能解析我的参数

我有一个相对简单的 swagger 文档,它没有被解析,并且我在验证它时收到的错误消息对我来说没有意义:

以下是我的招摇文档:

我从http://editor.swagger.io/#/收到以下异常