Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@fresha/openapi-codegen-docs-json-api

surgeventures13MIT0.4.0TypeScript support: included

Better OpenAPI documentation generator for JSON:API

OpenAPI, JSON:API, documentation generator

readme

@fresha/openapi-codegen-docs-json-api

Documentation generator for OpenAPI schemas.

Installation

This generator is installed along with @fresha/openapi-codegen.

$ npm install @fresha/openapi-codegen

Usage

Listing available options

npx fresha-openapi-codegen docs-json-api --help

Generating source code

npx fresha-openapi-codegen docs-json-api \
  --input PATH_TO_OPENAPI_SCHEMA_FILE
  --output ROOT_DIR_NPM_PROJECT
  --json-api

where:

--json-api is used to make generator generate the code according to JSON:API specification