Docs

Install

npm

npm install @basketry/typescript-docs

yarn

yarn add @basketry/typescript-docs

pnpm

pnpm add @basketry/typescript-docs

Basic Usage

basketry.config.json

{
  "source": "petstore.json",
  "parser": "@basketry/openapi-3",
  "generators": ["@basketry/typescript-docs"],
  "output": "src"
}

File Structure

This generator will create an markdown file for each service defined by the source schema. Each file will contain a description of the service, its methods, their parameters, and all responses. All types referenced by the service will be included in the documentation. Some common types may be duplicated across multiple documentation files if they are used by multiple services.

my-project/
├── node_modules/
├── src/
│   ├── v1/                  <-- generated
│   │   └── pet-service.md   <-- generated
│   │   └── types.ts
│   ├── index.ts
├── .gitignore
├── basketry.config.json
├── package.json
├── petstore.json
└── README.md

Options

This generator depends on the @basketry/typescript generator and all of their applied options will also apply to files emitted by this generator.

See:

• @basketry/typescript options

The @basketry/typescript-docs generator does not accept any of its own options.