@flock/wirespec

中文文档
0.23.7发布于 2026/11/13Apache-2.0TypeScriptES Module零依赖构建来源已验证近 30 天下载 3433

简化你的API开发工作流程,加快实施,保证严格遵循确定的合同规范

中文使用文档
文档目录8 节
  1. 线视你的API
  2. 特征
  3. 安装
  4. 使用量
  5. 国 际
  6. 程序用途
  7. 捐款
  8. 许可证

电线

npm version license

线视你的API

简化你的API开发工作流程,加快实施,保证严格遵循确定的合同规范

线谱是一种使用合同先行的方法来简化界面设计的工具,其简洁可人可读的规格是真理的单一来源.

访问 电线.io 关于该项目的更多信息.

特征

  • 生成光谱文件: 自动在程序上创建线谱模板或定义.
  • 验证:确保您的光谱文件符合定义的策略和规格.
  • CLI 支持: 使用简单的CLI命令,轻松地与您的开发工作流程相融合.
  • 整合准备:与现代JavaScript/TypeScript项目合作良好.

安装

您可以安装 wirespec 在全球范围内或作为项目的一个长期依赖:

# Install as a dev dependency
npm install --save-dev wirespec

# Or install globally
npm install -g wirespec

使用量

国 际

这个 wirespec 插件可以通过命令行直接使用. 以下是一些示例命令:

# Create a new Wirespec file
wirespec generate <filename>

# Validate an existing Wirespec file
wirespec validate <filename>

程序用途

您还可以使用 wirespec 在您的 JavaScript 或 TypeScript 代码中:

import { generate, validate } from 'wirespec';

// Generate a Wirespec file
generate('example.wirespec');

// Validate a Wirespec file
const isValid = validate('example.wirespec');
console.log(`Is valid: ${isValid}`);

捐款

欢迎捐款! 如果您发现任何问题或想建议新的特征,请随意打开一个问题或提交 一个拉请求.

见 我们的捐款 详情

许可证

本项目根据以下规定获得许可证: Apache-2.0 许可证。 。 。 .


提高您的光谱开发工作流程 wirespec npm 图书馆.

版本与发布记录

@flock/wirespec 共发布 276 个版本,首次发布于 2023/07/31;过去 12 个月发布了 66 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.23.7latest2026/11/133 天前
0.23.62026/11/124 天前
0.23.52026/11/105 天前
0.23.42026/11/105 天前
0.23.32026/11/106 天前
0.23.22026/11/106 天前

其他发布通道:rc → 0.20.0-RC.16。

关于 @flock/wirespec 的常见问题

@flock/wirespec 是什么?

简化你的API开发工作流程,加快实施,保证严格遵循确定的合同规范

如何安装 @flock/wirespec?

在项目目录运行 npm install @flock/wirespec,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 wirespec、wirespec-lsp,可以用 npx wirespec 直接运行。

@flock/wirespec 支持 TypeScript 吗?

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

@flock/wirespec 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@flock/wirespec 可以商用吗?

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

@flock/wirespec 的下载量有多少?

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

@flock/wirespec 还在维护吗?

最新版本 0.23.7 发布于 2026/11/13(3 天前);至今共发布 276 个版本,其中过去 12 个月发布了 66 个;首次发布于 2023/07/31。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。