Swagger 客户端
Swagger 客户端是一个 JavaScript 模块,允许您获取、解析和与 Swagger/OpenAPI 文档交互。
新消息!
**这是 swagger-js 的新版本,3.x。**新版本支持 Swagger 2.0 以及 OpenAPI 3。
想了解更多?查看我们的常见问题。
关于 3.x 已知缺失的功能,请参阅废弃功能列表。
有关 swagger-js 的旧版本,请参考 2.x 分支。
npm 包名为
swagger-client
,而 GitHub 仓库名为swagger-js
。 我们很快会统一这一点。只是提前通知您。您可能会看到两个名称的引用。
兼容性
OpenAPI 规范自 2010 年创建以来经历了多次修订。 Swagger 客户端与 OpenAPI 规范的兼容性如下:
Swagger 客户端版本 | 发布日期 | OpenAPI 规范兼容性 | 备注 |
---|---|---|---|
3.19.x | 2023-01-23 | 2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3, 3.1.0 | 标签 v3.19.0-alpha.3 |
3.10.x | 2020-01-17 | 2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3 | 标签 v3.10.0 |
2.1.32 | 2017-01-12 | 1.0, 1.1, 1.2 | 标签 v2.1.32。此发布版仅在 GitHub 上可用。 |
文档
使用
开发
迁移
运行时
Node.js
swagger-client
需要 Node.js >=12.20.0
,并根据 Node.js 版本使用不同的 fetch
实现。
>=12.20.0 <18
- node-fetch@3>=18
- 原生 Node.js fetch
注意:swagger-client 的最低 Node.js 运行时版本与 Node.js 发布保持一致, 这意味着我们可以在不进行主要版本升级的情况下停止支持已达到生命周期结束(EOL)的 Node.js 版本。
浏览器
swagger-client
适用于最新版本的 Chrome、Safari、Firefox 和 Edge 浏览器,
并使用每个支持的浏览器提供的原生 fetch 实现。
安全联系方式
请通过电子邮件 security@swagger.io 披露任何与安全相关的问题或漏洞,而不要使用公共问题跟踪器。