TS 中文文档

OpenAPI Typescript Codegen


Node.js library that generates Typescript clients based on the OpenAPI specification.


Why?


Frontend ❤️OpenAPI, but we do not want to use JAVA codegen in our builds
Quick, lightweight, robust and framework-agnostic 🚀
Supports generation of TypeScript clients
Supports generations of Fetch, Node-Fetch, Axios, Angular and XHR http clients
Supports OpenAPI specification v2.0 and v3.0
Supports JSON and YAML files for input
Supports generation through CLI, Node.js and NPX
Supports tsc and @babel/plugin-transform-typescript
Supports aborting of requests (cancelable promise pattern)
Supports external references using json-schema-ref-parser

Install


  1. ``` sh
  2. npm install openapi-typescript-codegen --save-dev

  4. ```

Usage


  1. ``` sh
  2. $ openapi --help

  4.   Usage: openapi [options]

  6.   Options:
  7.     -V, --version             output the version number
  8.     -i, --input <value>       OpenAPI specification, can be a path, url or string content (required)
  9.     -o, --output <value>      Output directory (required)
  10.     -c, --client <value>      HTTP client to generate [fetch, xhr, node, axios, angular] (default: "fetch")
  11.     --name <value>            Custom client class name
  12.     --useOptions              Use options instead of arguments
  13.     --useUnionTypes           Use union types instead of enums
  14.     --exportCore <value>      Write core files to disk (default: true)
  15.     --exportServices <value>  Write services to disk (default: true)
  16.     --exportModels <value>    Write models to disk (default: true)
  17.     --exportSchemas <value>   Write schemas to disk (default: false)
  18.     --indent <value>          Indentation options [4, 2, tab] (default: "4")
  19.     --postfixServices         Service name postfix (default: "Service")
  20.     --postfixModels           Model name postfix
  21.     --request <value>         Path to custom request file
  22.     -h, --help                display help for command

  24.   Examples
  25.     $ openapi --input ./spec.json --output ./generated
  26.     $ openapi --input ./spec.json --output ./generated --client xhr

  28. ```

Docker usage


To build the Docker container, execute the following command:

  1. ``` sh
  2. docker build . --tag openapi-typescript-codegen

  4. ```

After this is done, you can execute the CLI commands:

  1. ``` sh
  2. docker run openapi-typescript-codegen --help
  3. docker run openapi-typescript-codegen --input sample.yaml --output client

  5. ```

Documentation


Basic usage
OpenAPI object
Client instances --name
Argument vs. Object style --useOptions
Enums vs. Union types --useUnionTypes
Runtime schemas --exportSchemas
Enum with custom names and descriptions
Nullable props (OpenAPI v2)
Authorization
External references
Canceling requests
Custom request file

Support


Babel support
Axios support
Angular support
Node-Fetch support