flinkk-oas-cli - 0.1.0 - experimental

A command-line tool for all OpenAPI Specifications (OAS) related tooling.

Install

yarn add --dev @flinkk/shop-oas-cli

Install in the global namespace is not yet supported. ~~npm install -g @flinkk/shop-oas-cli~~

Configuration / First time setup

N/A

How to use

yarn flinkk-oas <command>

Command - oas

This command will scan the @flinkk/shop package in order to extract JSDoc OAS into a json file.

The command will output one of three the files admin.oas.json, store.oas.json or combined.oas.json in the same directory that the command was run.

Invalid OAS with throw an error and will prevent the files from being outputted.

--type <string>

Specify which API OAS to create. Accepts admin, store, combined.

The combined option will merge both the admin and the store APIs into a single OAS file.

yarn flinkk-oas oas --type admin

--out-dir <path>

Specify in which directory should the files be outputted. It accepts a relative or absolute path. If the directory doesn't exist, it will be created. Defaults to ./.

yarm flinkk-oas oas --out-dir

--paths <paths...>

Allows passing additional directory paths to crawl for JSDoc OAS and include in the generated OAS. It accepts multiple entries.

yarn flinkk-oas oas --paths ~/flinkk-server/src

--base <path>

Allows overwriting the content the API's base.yaml OAS that is fed to swagger-inline. Paths, tags, and components will be merged together. Other OAS properties will be overwritten.

yarn flinkk-oas oas --base ~/flinkk-server/oas/custom.oas.base.yaml

--dry-run

Will package the OAS but will not output file. Useful for validating OAS.

yarn flinkk-oas oas --dry-run

--force

Ignore OAS errors and attempt to output generated OAS files.

yarn flinkk-oas oas --force

Command - docs

Will sanitize OAS for use with Redocly's API documentation viewer.

--src-file <path>

Specify the path to the OAS JSON file.

yarm flinkk-oas docs --src-file ./store.oas.json

--out-dir <path>

Specify in which directory should the files be outputted. Accepts relative and absolute path. If the directory doesn't exist, it will be created. Defaults to ./.

yarn flinkk-oas docs --src-file ./store.oas.json --out-dir ./docs`

--config <path>

Specify the path to a Redocly config file.

yarn flinkk-oas --src-file ./store.oas.json --config ./redocly-config.yaml

--dry-run

Will sanitize the OAS but will not output file. Useful for troubleshooting circular reference issues.

yarn flinkk-oas docs --src-file ./store.oas.json --dry-run

--clean

Delete destination directory content before generating the docs.

yarn flinkk-oas docs --src-file ./store.oas.json --clean

--split

Creates a multi-file structure output. Uses redocly split internally.

yarn flinkk-oas docs --src-file ./store.oas.json --split

--preview

Generate a preview of the API documentation in a browser. Does not output files. Uses redocly preview-docs internally.

yarn flinkk-oas docs --src-file ../../../www/apps/api-reference/specs/store.oas.json --preview

--html

Generate a zero-dependency static HTML file. Uses redocly build-docs internally.

yarn flinkk-oas docs --src-file ./store.oas.json --html