Rebilly OpenAPI Definitions

TBD: Add Redocly validation status badge.

Links

• Core API docs
• Users API docs
• Reports API docs
• Storefront API docs

Working on the API definitions

Install

1. Install Node JS
2. Clone repo and run npm ci in the repo root

Usage

Preview

Starts the development server to preview the docs:

• npm run serve-core - preview Core API docs
• npm run serve-users - preview Users API docs
• npm run serve-reports - preview Reports API doc
• npm run serve-storefront - preview Storefront API docs
• npm run serve-combined - preview combined API docs

Build

Run npm run build to bundle the definitions into a single file in the dist folder.

Validate

Run npm test to validate the definitions.

Organization

Each API definition has its own root document in the root of the openapi folder.