@apielements/apib-parser

中文文档
0.20.1发布于 2020/08/06MITCommonJS近 30 天下载 4543

API Blueprint parser for API Elements

原始使用文档

API Elements: API Blueprint Parser

NPM version License

This adapter provides support for parsing API Blueprint in Fury.js using the Node API Blueprint parser Drafter NPM.

Install

$ npm install @apielements/apib-parser

Usage

import fury from 'fury';
import apibParser from '@apielements/apib-parser';

fury.use(apibParser);

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

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

版本与发布记录

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

版本发布日期距今
0.20.1latest2020/08/066 年前
0.20.02020/06/126 年前
0.19.02020/04/296 年前

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

@apielements/apib-parser 是什么?

API Blueprint parser for API Elements

如何安装 @apielements/apib-parser?

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

@apielements/apib-parser 支持 TypeScript 吗?

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

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

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

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

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

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

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

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

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

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

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