@apielements/openapi2-parser

中文文档
0.32.6发布于 2021/07/16MITCommonJS近 30 天下载 2.5万

Fury.js的 Swagger 2. 0 解析器

中文使用文档
文档目录4 节
  1. 安装
  2. 使用量
  3. 解析器代码
  4. 斯瓦格供应商扩展

API 元素: OpenAPI 2. 0 适应器

NPM version License

此适配器为解析提供支持 斯瓦格2.0 内 愤怒。它尚未提供序列器.

安装

$ npm install @apielements/openapi2

使用量

import fury from 'fury';
import openApi2Parser from '@apielements/openapi2';

fury.use(openApi2Parser);

fury.parse({source: '... your OpenAPI 2.0 document ...'}, (err, result) => {
  if (err) {
    console.log(err);
    return;
  }

  // The returned `result` is a Minim parse result element.
  console.log(result.api.title);
});

解析器代码

以下代码被解析器在创建警告和错误说明时使用.

警告:

代码说明
2个由于输入格式或对输入进行解析的问题,无法提供原始地图.
3个数据正在转换中丢失 .

错误 :

代码说明
1个解析输入出错( 例如 YAML) .
页:1Swagger 验证错误 .
页:1Swagger 到 Refract 转换器错误( JS 例外) .

斯瓦格供应商扩展

源代码 Swagger 文件中的一些 Swagger 供应商扩展名被转换 输入输出 API 元素作为扩展元素.

以下供应商延伸地点得到支持:

  • 信息对象内部
  • 路径中的对象
  • 在路径项目对象中
  • 在操作对象内
  • 在回复对象内
  • 在安全计对象内

这些供应商扩展将使用这种关系作为扩展 https://help.apiary.io/profiles/api-elements/vendor-extensions/。 。 。 .

版本与发布记录

@apielements/openapi2-parser 共发布 10 个版本,首次发布于 2020/04/30;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.32.6latest2021/07/165 年前
0.32.52021/02/245 年前
0.32.42020/10/136 年前
0.32.32020/08/066 年前
0.32.22020/07/226 年前
0.32.12020/06/226 年前

关于 @apielements/openapi2-parser 的常见问题

@apielements/openapi2-parser 是什么?

Fury.js的 Swagger 2. 0 解析器

如何安装 @apielements/openapi2-parser?

在项目目录运行 npm install @apielements/openapi2-parser,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@apielements/core(>=0.1.0 <0.3.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@apielements/openapi2-parser 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/apielements__openapi2-parser 是否存在。

@apielements/openapi2-parser 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@apielements/openapi2-parser 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=8。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@apielements/openapi2-parser 可以商用吗?

@apielements/openapi2-parser 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@apielements/openapi2-parser 的下载量有多少?

根据 npm 官方下载统计,@apielements/openapi2-parser 在 2026/10/06 – 2026/11/04 这 30 天内被下载 24,980 次,日均约 833 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@apielements/openapi2-parser 还在维护吗?

最新版本 0.32.6 发布于 2021/07/16(5 年前);至今共发布 10 个版本,其中过去 12 个月发布了 0 个;首次发布于 2020/04/30。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。