Back to Scalar

Scalar Galaxy Example

packages/galaxy/README.md

latest2.8 KB
Original Source

Scalar Galaxy Example

OpenAPI and AsyncAPI example documents in YAML and JSON to test OpenAPI and AsyncAPI tooling, run test suites or learn about OpenAPI and AsyncAPI.

Installation

bash
npm install @scalar/galaxy

Usage

Scalar Registry

VersionFormatURL
LatestPreviewhttps://registry.scalar.com/@scalar/apis/galaxy
LatestJSONhttps://registry.scalar.com/@scalar/apis/galaxy?format=json
LatestYAMLhttps://registry.scalar.com/@scalar/apis/galaxy?format=yaml

CDN

VersionFormatURL
OpenAPI LatestJSONhttps://cdn.jsdelivr.net/npm/@scalar/galaxy/dist/latest.json
OpenAPI LatestYAMLhttps://cdn.jsdelivr.net/npm/@scalar/galaxy/dist/latest.yaml
OpenAPI 3.1JSONhttps://cdn.jsdelivr.net/npm/@scalar/galaxy/dist/3.1.json
OpenAPI 3.1YAMLhttps://cdn.jsdelivr.net/npm/@scalar/galaxy/dist/3.1.yaml
AsyncAPI LatestJSONhttps://cdn.jsdelivr.net/npm/@scalar/galaxy/dist/asyncapi/latest.json
AsyncAPI LatestYAMLhttps://cdn.jsdelivr.net/npm/@scalar/galaxy/dist/asyncapi/latest.yaml
AsyncAPI 3.0JSONhttps://cdn.jsdelivr.net/npm/@scalar/galaxy/dist/asyncapi/3.0.json
AsyncAPI 3.0YAMLhttps://cdn.jsdelivr.net/npm/@scalar/galaxy/dist/asyncapi/3.0.yaml

Import as object

ts
import ScalarGalaxy from '@scalar/galaxy/latest.json'

Import as JSON string

ts
import ScalarGalaxy from '@scalar/galaxy/latest.json?raw'

Import as YAML string

ts
import ScalarGalaxy from '@scalar/galaxy/latest.yaml?raw'

Import specific OpenAPI version

ts
import ScalarGalaxy from '@scalar/galaxy/3.1.json'

Serve the OpenAPI document using the CLI

bash
npx @scalar/cli document serve ./src/documents/3.1.yaml --watch

Community

We are API nerds. You too? Let's chat on Discord: https://discord.gg/scalar

License

The source code in this repository is licensed under MIT.