π Convert OpenAPI 3.0 and 2.0 (Swagger) schemas to TypeScript interfaces using Node.js.
π The output is prettified with Prettier (and can be customized!).
π Works for both local and remote resources (filesystem and HTTP).
View examples:
npx openapi-typescript schema.yaml --output schema.ts
# π€ Loading spec from tests/v2/specs/stripe.yamlβ¦
# π schema.yaml -> schema.ts [250ms]npx openapi-typescript https://petstore.swagger.io/v2/swagger.json --output petstore.ts
# π€ Loading spec from https://petstore.swagger.io/v2/swagger.jsonβ¦
# π https://petstore.swagger.io/v2/swagger.json -> petstore.ts [650ms]Thanks to @psmyrdek for the remote spec feature!
Import any top-level item from the generated spec to use it. It works best if you also alias types to save on typing:
import { components } from './generated-schema.ts';
type APIResponse = components["schemas"]["APIResponse"];The reason for all the ["β¦"] everywhere is because OpenAPI lets you use more characters than are valid TypeScript identifiers. The goal of this project is to generate all of your schema, not merely the parts that are βTypeScript-safe.β
Also note that thereβs a special operations interface that you can import OperationObjects by their operationId:
import { operations } from './generated-schema.ts';
type getUsersById = operations["getUsersById"];This is the only place where our generation differs from your schema as-written, but itβs done so as a convenience and shouldnβt cause any issues (you can still use deep references as-needed).
Thanks to @gr2m for the operations feature!
npx openapi-typescript schema.yamlIn your package.json, for each schema youβd like to transform add one generate:specs:[name] npm-script. Then combine
them all into one generate:specs script, like so:
"scripts": {
"generate:specs": "npm run generate:specs:one && npm run generate:specs:two && npm run generate:specs:three",
"generate:specs:one": "npx openapi-typescript one.yaml -o one.ts",
"generate:specs:two": "npx openapi-typescript two.yaml -o two.ts",
"generate:specs:three": "npx openapi-typescript three.yaml -o three.ts"
}If you use npm-run-all, you can shorten this:
"scripts": {
"generate:specs": "run-p generate:specs:*",You can even specify unique options per-spec, if needed. To generate them all together, run:
npm run generate:specsRinse and repeat for more specs.
For anything more complicated, or for generating specs dynamically, you can also use the Node API.
| Option | Alias | Default | Description |
|---|---|---|---|
--output [location] |
-o |
(stdout) | Where should the output file be saved? |
--auth [token] |
(optional) Provide an auth token to be passed along in the request (only if accessing a private schema). | ||
--prettier-config [location] |
(optional) Path to your custom Prettier configuration for output | ||
--raw-schema |
false |
Generate TS types from partial schema (e.g. having components.schema at the top level) |
npm i --save-dev openapi-typescriptconst { readFileSync } = require("fs");
const swaggerToTS = require("openapi-typescript").default;
const input = JSON.parse(readFileSync("spec.json", "utf8")); // Input can be any JS object (OpenAPI format)
const output = swaggerToTS(input); // Outputs TypeScript defs as a string (to be parsed, or written to a file)The Node API is a bit more flexible: it will only take a JS object as input (OpenAPI format), and return a string of TS definitions. This lets you pull from any source (a Swagger server, local files, etc.), and similarly lets you parse, post-process, and save the output anywhere.
If your specs are in YAML, youβll have to convert them to JS objects using a library such as js-yaml. If youβre batching large folders of specs, glob may also come in handy.
- Support converting any OpenAPI 3.0 or 2.0 (Swagger) schema to TypeScript types, no matter how complicated
- The generated TypeScript types must match your schema as closely as possible (i.e. donβt convert names to
PascalCaseor follow any TypeScript-isms; faithfully reproduce your schema as closely as possible, capitalization and all) - This library is a TypeScript generator, not a schema validator.
PRs are welcome! Please see our CONTRIBUTING.md guide. Opening an issue beforehand to discuss is encouraged but not required.
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!