swagger-typescript-api Documentation

File: README.md Copy Chapter

Swagger TypeScript API

• Support for OpenAPI 3.0, 2.0, JSON and YAML
• Generate the API Client for Fetch or Axios from an OpenAPI Specification

Any questions you can ask here: https://github.com/acacode/swagger-typescript-api/discussions

Examples Copy Chapter

All examples you can find here: https://github.com/acacode/swagger-typescript-api/tree/main/tests

Usage Copy Chapter

You can use this package in two ways:

CLI Copy Section

npx swagger-typescript-api generate --path ./swagger.json

Or install locally in your project:

npm install --save-dev swagger-typescript-api
npx swagger-typescript-api generate --path ./swagger.json

Library Copy Section

npm install --save-dev swagger-typescript-api

import * as path from "node:path";
import * as process from "node:process";
import { generateApi } from "swagger-typescript-api";

await generateApi({ input: path.resolve(process.cwd(), "./swagger.json") });

For more detailed configuration options, please consult the documentation.

Mass media Copy Chapter

• 5 Lessons learned about swagger-typescript-api
• Why Swagger schemes are needed in frontend development ?
• Migration en douceur vers TypeScript (French)
• swagger-typescript-api usage (Japanese)
• Working with REST APIs using swagger-typescript-api (Russian)
• Using custom templates and configs for swagger-typescript-api (Russian)

License Copy Chapter

Licensed under the MIT License.

File: templates/modular/README.md Copy Chapter

swagger-typescript-api

templates/modular

This templates use for multiple api files (--modular option)

path prefix @modular

File: templates/default/README.md Copy Chapter

swagger-typescript-api

templates/default

This templates use for single api file (without --modular option)

path prefix @default

File: templates/base/README.md Copy Chapter

swagger-typescript-api

templates/base

This templates use both for multiple api files and single api file

path prefix @base

File: templates/README.md Copy Chapter

swagger-typescript-api

templates

Templates:

• api.ejs - (generates file) Api class module (locations: default, modular)
• data-contracts.ejs - (generates file) all types (data contracts) from swagger schema (locations: base)
• http-client.ejs - (generates file) HttpClient class module (locations: base)
• procedure-call.ejs - (subtemplate) route in Api class (locations: default, modular)
• route-docs.ejs - (generates file) documentation for route in Api class (locations: base)
• route-name.ejs - (subtemplate) route name for route in Api class (locations: base)
• route-type.ejs - (--route-types option) (subtemplate) (locations: base)
• route-types.ejs - (--route-types option) (subtemplate) (locations: base) - data-contract-jsdoc.ejs - (subtemplate) generates JSDOC for data contract (locations: base)