Node Package Manager

    openapi-client-axios-typegen
    TypeScript icon, indicating that this package has built-in type declarations

    6.0.0 • Public • Published

    OpenAPI Client Axios Typegen

    CI npm version License

    Type generator for openapi-client-axios

    Generating type files (.d.ts)

    TypeScript IntelliSense

    openapi-client-axios comes with a tool called typegen to generate typescript type files (.d.ts) for OpenAPIClient instances using an OpenAPI definition file.

    $ npm install -g openapi-client-axios-typegen
    
    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://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml
    

    Contributing

    OpenAPI Client Axios Typegen is Free and Open Source Software. Issues and pull requests are more than welcome!

    Install

    npm i openapi-client-axios-typegen

    DownloadsWeekly Downloads

    9,472

    Version

    6.0.0

    License

    MIT

    Unpacked Size

    18.4 kB

    Total Files

    6

    Last publish

    Collaborators

    • anttiviljami