# @blockfrost/openapi 中文文档 规范地址：https://npmcn.com/package/%40blockfrost/openapi/ 版本：0\.1\.93 npm 元数据更新时间：2026-09-02T11:43:28.800Z 中文译文更新时间：2026-11-08T07:17:16.698Z 软件包许可：未声明 本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。 原始 npm 页面：https://www.npmjs.com/package/%40blockfrost/openapi 原文对照：https://npmcn.com/package/%40blockfrost/openapi/?lang=original 项目主页：https://github.com/blockfrost/openapi#readme 源码仓库：https://github.com/blockfrost/openapi ## 关键信息（来自 npm 元数据） - 包体积（解压后）：1.5 MB，27 个文件 - 模块格式：CommonJS - TypeScript 类型：包内自带 - Node.js 要求：\>=20 - 运行依赖：4 个 - 首次发布：2021-02-17T12:45:08.111Z - 最新版本发布：2026-09-02T11:43:28.418Z - 近 30 天下载量：103577（2026-10-09 至 2026-11-07，npm 官方下载统计） - 已发布版本数：274（近 12 个月 29 个） ## 中文简介 Blockfrost.io 的 OpenAPI 规格 ## 安装 ```sh npm install @blockfrost/openapi ``` 也可以使用：`pnpm add @blockfrost/openapi`、`yarn add @blockfrost/openapi`、`bun add @blockfrost/openapi` ## README ![](https://blockfrost.io/images/logo.svg) # Blockfrost.io OpenAPI 软件 开源 OpenAPI 规格 [块霜.io](https://blockfrost.io/) 后端API. ![GitHub](https://img.shields.io/github/license/blockfrost/openapi) ![master build ci](https://github.com/blockfrost/openapi/actions/workflows/CI.yaml/badge.svg?branch=master) [![npm version](https://badge.fury.io/js/%40blockfrost%2Fopenapi.svg)](https://badge.fury.io/js/%40blockfrost%2Fopenapi) ![downloads](https://img.shields.io/npm/dy/@blockfrost/openapi) [![](https://img.shields.io/badge/made%20by-Five%20Binaries-darkviolet.svg?style=flat-square)](https://fivebinaries.com/) [开始](https://npmcn.com/package/%40blockfrost/openapi/#readme-getting-started) 二. 支助 [发展](https://npmcn.com/package/%40blockfrost/openapi/#readme-development) ## 开始 这个 **开发版本** 可在 `master` 树枝. 这个 **最近的活动发布** 可见于 [GitHub 发布](https://github.com/blockfrost/openapi/releases)。 。 。 . 给 **已出版文件**访问 [文件:blockfrost.io](https://docs.blockfrost.io/)。 。 。 . ## 发展 块冻 OpenAPI [`blockfrost-openapi.yaml`](https://npmcn.com/package/%40blockfrost/openapi/blockfrost-openapi.yaml) 规格来自所有 yaml 文件 `src` 目录. 还有Mithril聚合物API谱 [`mithril.yaml`](https://npmcn.com/package/%40blockfrost/openapi/mithril.yaml) 可下载自 [米斯里尔·吉苏布](https://github.com/input-output-hk/mithril)。 。 。 . 这两道棋子然后通过 `openapi-merge-cli` (配置在内部) [`openapi-merge.json`](https://npmcn.com/package/%40blockfrost/openapi/openapi-merge.json)) (中文(简体) ). 只有带有标签的Mithril端点 `Cardano » Mithril` 包含在最后的规格中. > 标记 `Cardano » Mithril` 需要手动添加到Mithril OpenAPI spec中每个相关端点. 如果您添加了新文件, 请不要忘记添加到 `paths` 内 [`src/definitions.yaml`](https://npmcn.com/package/%40blockfrost/openapi/src/definitions.yaml)。 。 。 . 编辑源 Yaml 文件并构建软件包 : ```typescript yarn build ``` ### 恢复类型 类型 :[`src/generated-types.ts`](https://npmcn.com/package/%40blockfrost/openapi/src/generated-types.ts))作为组件重新生成 `yarn build`,或单独使用: ```console yarn generate-types ``` 粗体类型 [`rust/`](https://npmcn.com/package/%40blockfrost/openapi/rust/) 由捆绑物生成的 [`openapi.yaml`](https://npmcn.com/package/%40blockfrost/openapi/openapi.yaml)运行 `yarn build` (或至少 `yarn bundle`)首先,如果您已经更改了源 Yaml 文件。 代号使用 [openapi 生成器](https://github.com/OpenAPITools/openapi-generator),这需要 Java 运行时间 : ```console yarn generate-types:rust ``` 如果没有Java安装,请使用多克变体,该变体在一个容器内运行相同的生成器版本: ```console yarn generate-types:rust:docker ``` 生成器版本被固定在 [`openapitools.json`](https://npmcn.com/package/%40blockfrost/openapi/openapitools.json) ——当撞倒时,更新图像标记在 `generate-types:rust:docker` 脚本匹配. > 注意: " Rust " 一代只发出型号(`apis=false`),所以光谱变化,仅能触摸端点或查询参数,不会产生箱子中的任何变化. ### 午夜图形QL 文件 午夜索引器 GraphQL API 文档使用 [光谱QL](https://github.com/anvilco/spectaql) 从计划文件中 [`midnight-indexer-api.graphql`](https://npmcn.com/package/%40blockfrost/openapi/midnight-indexer-api.graphql)中的 SpectaQL 配置 [`spectaql.yaml`](https://npmcn.com/package/%40blockfrost/openapi/spectaql.yaml) 自定义主题在 [`spectaql-theme/`](https://npmcn.com/package/%40blockfrost/openapi/spectaql-theme/)。 。 。 . 要更新 GraphQL 计划, 请从中下载匹配已部署的午夜索引器的版本 [午夜索引器仓库](https://github.com/midnightntwrk/midnight-indexer/blob/main/indexer-api/graphql/) 并替换本地文件 : 然后重建与 `yarn bundle` (SpectaQL 作为捆绑步骤的一部分运行) 以重生 `docs/midnight/`。 。 。 . 自由开放公关对抗 `master` 树枝。 对于Blockfrost API的新特性和变化. ### 用户 当您推动新任务时, 您分支的文档会自动生成到 Vercel 上, 并添加到您的 PR 中作为部署 . ### 盘式 API 文件 冰冻 **发光板 API** 记录 [`docs.blockfrost.io/dashboard-api/`](https://docs.blockfrost.io/dashboard-api/) 实值 **没有** 由这个repo建造. 它的 OpenAPI spec 和 Scalar 构建活性 单独部署,作为自己的Vercel项目。 这只拥有 `docs.blockfrost.io` 主机和倒置代号 `/dashboard-api/*` 给那个 通过项目 `rewrites` 规则 [`vercel.json`](https://npmcn.com/package/%40blockfrost/openapi/vercel.json) - 每个服务 检查和建造输油管 停留在自己的回收. ## 使用量 您可以下载 [`openapi.yaml`](https://npmcn.com/package/%40blockfrost/openapi/openapi.yaml) 直接取自寄存器或将此工程作为您的 JavaScript/ TypeScript 项目中的依赖 . ### 字体示例 安装 `@blockfrost/openapi`数字 : ```console yarn add @blockfrost/openapi ``` 或者说 ```console npm install @blockfrost/openapi ``` 现在您可以使用 OpenAPI 规格生成的 TypeScript 类型 : ```typescript import { components } from '@blockfrost/openapi'; type Block = components['schemas']['block_content']; type Address = components['schemas']['address_content']; type UtxoAsset = components['schemas']['address_utxo_content']; ``` ### 破烂箱子 添加 `blockfrost-openapi` 给您的 `Cargo.toml`数字 : ```toml [dependencies] blockfrost-openapi = "0.1.87" ``` 现在您可以使用生成的 Rust 类型 : ```rust use blockfrost_openapi::models::{BlockContent, AddressContent, AddressUtxoContentInner}; ``` ## 常见问题 ### @blockfrost/openapi 是什么？ Blockfrost\.io 的 OpenAPI 规格 ### 如何安装 @blockfrost/openapi？ 在项目目录运行 npm install @blockfrost/openapi，或使用 pnpm add / yarn add / bun add。 ### @blockfrost/openapi 支持 TypeScript 吗？ 支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。 ### @blockfrost/openapi 支持 ESM 还是 CommonJS？ 以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。 ### @blockfrost/openapi 需要什么版本的 Node\.js？ package\.json 的 engines 字段要求 Node\.js \>=20。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。 ### @blockfrost/openapi 可以商用吗？ @blockfrost/openapi 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。 ### @blockfrost/openapi 的下载量有多少？ 根据 npm 官方下载统计，@blockfrost/openapi 在 2026/10/09 – 2026/11/07 这 30 天内被下载 103,577 次，日均约 3,453 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。 ### @blockfrost/openapi 还在维护吗？ 最新版本 0\.1\.93 发布于 2026/09/02（2 个月前）；至今共发布 274 个版本，其中过去 12 个月发布了 29 个；首次发布于 2021/02/17。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。