symbol-openapi

OpenAPI specification for catapult-rest.

Requirements

• Node.js 18 LTS or higher
• Python 3 with the venv module available

Installation

1. Clone the symbol-openapi repository.

git clone https://github.com/symbol/symbol-openapi.git

2. Install dependencies.

npm install

3. If your system Python does not provide venv by default, install it first.

# Ubuntu / Debian
sudo apt install python3-venv

Commands

Build

Compile the specification. The generated output is saved under the _build directory.

npm run build

Test

Validate the specification using Redocly CLI, yamllint, and link checks.

Before running linting or tests for the first time, create the local Python virtual environment used by yamllint:

npm run lint:yaml:setup

npm test

Postman

Generate a Postman collection from the built specification.

npm run postman

Contributing

Before contributing please read this.

License

Copyright (c) 2018 Jaguar0625, gimre, BloodyRookie, Tech Bureau, Corp Licensed under the GNU Lesser General Public License v3