Skip to content

BitxorCorp/bitxor-openapi

Repository files navigation

bitxor-openapi

OpenAPI specification for bitxorcore-rest.

Requirements

  • Node.js 12 LTS

Installation

  1. Clone the bitxor-openapi repository.
git clone https://github.com/BitxorCorp/bitxor-openapi.git
  1. Install swagger-cli globally.
npm install -g @apidevtools/swagger-cli

Commands

Build

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

npm run build

Test

Check if the specification is valid.

npm run test

Contributing

Before contributing please read this.

License

Copyright (c) 2023 Bitxor Community

About

OpenAPI specification for Bitxor api-rest

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published