openapi-client-axios-typegen
v7.7.0
Published
Typescript type generator for openapi-client-axios
Downloads
40,067
Maintainers
Readme
OpenAPI Client Axios Typegen
Type generator for openapi-client-axios
Tip: It's recommended to use
openapicmd typegen
to generate types instead of directly installing the openapi-client-axios-typegen package.
Documentation
New! OpenAPI Client Axios documentation is now found on openapistack.co
https://openapistack.co/docs/openapi-client-axios/intro
Usage
Usage: typegen [file]
Options:
--help Show help [boolean]
--version Show version number [boolean]
Examples:
typegen ./openapi.yml > client.d.ts - generate a type definition file
The output of typegen
exports a type called Client
, which can be used for instances created with OpenAPIClientAxios
.
Both the api.getClient()
and api.init()
methods support passing in a Client type.
import { Client as PetStoreClient } from './client.d.ts';
const client = await api.init<PetStoreClient>();
const client = await api.getClient<PetStoreClient>();
typegen
supports using both local and remote URLs for OpenAPI definition files.
$ typegen ./petstore.yaml
$ typegen https://petstore3.swagger.io/api/v3/openapi.json
Contributing
OpenAPI Client Axios Typegen is Free and Open Source Software. Issues and pull requests are more than welcome!