@api-components/api-schema-document

中文文档
4.3.7发布于 2024/04/23Apache-2.0TypeScriptESM + CJS近 30 天下载 3127

使 XML 方案具有示例的组件

中文使用文档
文档目录8 节
  1. 版本兼容性
  2. 使用量
  3. 安装
  4. 在 html 文件内
  5. 在一个LitElement中
  6. 发展
  7. 本地运行演示
  8. 运行测试

被否决

这一部分正在贬值。 代码基础已移动到 api 文档 模块。 此模块将在 第37号共和国文件 合并.


一个组件,用于渲染XML/JSON schema,为API模型提供示例.

Published on NPM

Tests and publishing

版本兼容性

此版本仅与AMF模式版本2(AMF parser QQ 4.0.0)相通. 用于与上一个模型版本的兼容性 3.x.x 版本的组件.

使用量

安装

npm install --save @api-components/api-schema-document

在 html 文件内

<html>
  <head>
    <script type="module">
      import '@api-components/api-schema-document/api-schema-document.js';
    </script>
  </head>
  <body>
    <api-schema-document></api-schema-document>
  </body>
</html>

在一个LitElement中

import { LitElement, html } from 'lit-element';
import '@api-components/api-schema-document/api-schema-document.js';

class SampleElement extends PolymerElement {
  render() {
    return html`
    <api-schema-document .amf="${this.amf}"></api-schema-document>
    `;
  }
}
customElements.define('sample-element', SampleElement);

发展

git clone https://github.com/advanced-rest-client/api-schema-document
cd api-schema-document
npm install

本地运行演示

npm start

运行测试

npm test

版本与发布记录

@api-components/api-schema-document 共发布 20 个版本,首次发布于 2018/05/19;过去 12 个月发布了 0 个版本。

版本发布日期距今
4.3.7latest2024/04/232 年前
4.3.62023/11/182 年前
4.3.32023/07/043 年前
4.3.22022/02/254 年前
4.3.12021/10/015 年前
4.3.02021/03/195 年前

关于 @api-components/api-schema-document 的常见问题

@api-components/api-schema-document 是什么?

使 XML 方案具有示例的组件

如何安装 @api-components/api-schema-document?

在项目目录运行 npm install @api-components/api-schema-document,或使用 pnpm add / yarn add / bun add。

@api-components/api-schema-document 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@api-components/api-schema-document 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@api-components/api-schema-document 可以商用吗?

@api-components/api-schema-document 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@api-components/api-schema-document 的下载量有多少?

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

@api-components/api-schema-document 还在维护吗?

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