@blockfrost/openapi

Blockfrost.io OpenAPI

Open Source OpenAPI specification for Blockfrost.io backend API.

Getting started • Development

Getting started

Active version can be found in released branch and also in GitHub releases.

Development version is in master branch and is being merged into released upon each release.

Released documentation can be found at docs.blockfrost.io.

Development

Blockfrost OpenAPI blockfrost-openapi.yaml specification is generated from all yaml files in src directory. Then there is Mithril Aggregator API spec mithril.yaml which can be downloaded from Mithril Github. These two specs are then merged together via openapi-merge-cli (configuration is inside openapi-merge.json). Only the Mithril endpoints with a tag Cardano » Mithril are included into the final spec.

Tag Cardano » Mithril needs to be added manually to each relevant endpoint in Mithril OpenAPI spec.

If you add a new file then don't forget to add it to paths in src/definitions.yaml.

Edit the source yaml files and build the package:

yarn build

To build the documentation, run:

yarn generate-docs

Feel free to open PR against the master branch. It is a great place to start any discussion for new features and changes to the Blockfrost API.

Usage

You can download openapi.yaml directly from the repository or use this project as a dependency in your JavaScript/TypeScript project.

Typescript example

Install @blockfrost/openapi:

yarn add @blockfrost/openapi

or

npm install @blockfrost/openapi

Now you can use TypeScript types generated from the OpenAPI specification:

import { components } from '@blockfrost/openapi';

type Block = components['schemas']['block_content'];
type Address = components['schemas']['address_content'];
type UtxoAsset = components['schemas']['address_utxo_content'];