Blockfrost.io OpenAPI 软件
开源 OpenAPI 规格 块霜.io 后端API.
开始
这个 开发版本 可在 master 树枝.
这个 最近的活动发布 可见于 GitHub 发布。 。 。 .
给 已出版文件访问 文件:blockfrost.io。 。 。 .
发展
块冻 OpenAPI blockfrost-openapi.yaml 规格来自所有 yaml 文件 src 目录.
还有Mithril聚合物API谱 mithril.yaml 可下载自 米斯里尔·吉苏布。 。 。 .
这两道棋子然后通过 openapi-merge-cli (配置在内部) openapi-merge.json) (中文(简体) ).
只有带有标签的Mithril端点 Cardano » Mithril 包含在最后的规格中.
标记
Cardano » Mithril需要手动添加到Mithril OpenAPI spec中每个相关端点.
如果您添加了新文件, 请不要忘记添加到 paths 内 src/definitions.yaml。 。 。 .
编辑源 Yaml 文件并构建软件包 :
yarn build
恢复类型
类型 :src/generated-types.ts)作为组件重新生成 yarn build,或单独使用:
yarn generate-types
粗体类型 rust/ 由捆绑物生成的 openapi.yaml运行 yarn build (或至少 yarn bundle)首先,如果您已经更改了源 Yaml 文件。 代号使用 openapi 生成器,这需要 Java 运行时间 :
yarn generate-types:rust
如果没有Java安装,请使用多克变体,该变体在一个容器内运行相同的生成器版本:
yarn generate-types:rust:docker
生成器版本被固定在 openapitools.json ——当撞倒时,更新图像标记在 generate-types:rust:docker 脚本匹配.
注意: " Rust " 一代只发出型号(
apis=false),所以光谱变化,仅能触摸端点或查询参数,不会产生箱子中的任何变化.
午夜图形QL 文件
午夜索引器 GraphQL API 文档使用 光谱QL 从计划文件中 midnight-indexer-api.graphql中的 SpectaQL 配置 spectaql.yaml 自定义主题在 spectaql-theme/。 。 。 .
要更新 GraphQL 计划, 请从中下载匹配已部署的午夜索引器的版本 午夜索引器仓库 并替换本地文件 :
然后重建与 yarn bundle (SpectaQL 作为捆绑步骤的一部分运行) 以重生 docs/midnight/。 。 。 .
自由开放公关对抗 master 树枝。 对于Blockfrost API的新特性和变化.
用户
当您推动新任务时, 您分支的文档会自动生成到 Vercel 上, 并添加到您的 PR 中作为部署 .
盘式 API 文件
冰冻 发光板 API 记录
docs.blockfrost.io/dashboard-api/
实值 没有 由这个repo建造. 它的 OpenAPI spec 和 Scalar 构建活性
单独部署,作为自己的Vercel项目。 这只拥有
docs.blockfrost.io 主机和倒置代号 /dashboard-api/* 给那个
通过项目 rewrites 规则 vercel.json - 每个服务
检查和建造输油管 停留在自己的回收.
使用量
您可以下载 openapi.yaml 直接取自寄存器或将此工程作为您的 JavaScript/ TypeScript 项目中的依赖 .
字体示例
安装 @blockfrost/openapi数字 :
yarn add @blockfrost/openapi
或者说
npm install @blockfrost/openapi
现在您可以使用 OpenAPI 规格生成的 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数字 :
[dependencies]
blockfrost-openapi = "0.1.87"
现在您可以使用生成的 Rust 类型 :
use blockfrost_openapi::models::{BlockContent, AddressContent, AddressUtxoContentInner};