npmpackage.info

openapi-axios-client-typegen

JavaScript client library for consuming OpenAPI-enabled APIs with axios

5.0.6

577

MIT

TypeScript

18.09 kB

1,708 4

Installations

npm install openapi-axios-client-typegen

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

16.14.2

NPM Version

lerna/4.0.0/node@v16.14.2+arm64 (darwin)

Score

54.5

Supply Chain

78.7

Quality

73.8

Maintenance

Vulnerability

97.9

License

Pull Requests

Open

1

Total

81

Closed

22

Merged

58

Issues

Open

24

Total

114

Closed

90

Releases

v7.0.0 - Remove SwaggerParser

7.0.0

Published on 11 Feb 2023

v6.1.0 - remove node https / http dependencies

6.1.0

Published on 14 Jan 2023

v6.0.0 – axios v1 support

6.0.0

Published on 14 Nov 2022

View all 3 releases

Contributors

Unable to fetch Contributors

View all 27 contributors

Languages

TypeScript

JavaScript

Shell

TypeScript (99.1%)

JavaScript (0.8%)

Shell (0.1%)

Developer

anttiviljami

Download Statistics

Total Downloads

1,708

Last Day

Last Week

Last Month

Last Year

275

GitHub Statistics

577 Stars

448 Commits

68 Forks

7 Watching

7 Branches

27 Contributors

Maintainers

Package Meta Information

Latest Version

5.0.6

Package Id

openapi-axios-client-typegen@5.0.6

Unpacked Size

18.09 kB

Size

5.92 kB

File Count

NPM Version

lerna/4.0.0/node@v16.14.2+arm64 (darwin)

Node Version

16.14.2

Total Downloads

Cumulative downloads

Total Downloads

1,708

Last day

-83.3%

Compared to previous day

Last week

28.6%

Compared to previous week

Last month

500%

Compared to previous month

Last year

30.3%

275

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

@anttiviljami/dtsgenerator @apidevtools/json-schema-ref-parser axios indent-string lodash openapi-axios-client openapi-types swagger-parser yargs

Dev Dependencies

@types/jest @types/lodash @types/yargs jest ts-jest tslint tslint-microsoft-contrib typescript

Versions

OpenAPI Client Axios Typegen

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.

1import { Client as PetStoreClient } from './client.d.ts';
2
3const client = await api.init<PetStoreClient>();
4const 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!

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

9

SAST

Determines if the project uses static code analysis.

2

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

2

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

1

Maintained

Determines if the project is "actively maintained".

1

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Security-Policy

Determines if the project has published a security policy.

Score

4

/10

Last Scanned on 2025-01-27

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to openapi-axios-client-typegen

openapi-client-axios-typegen

7.7.0

Typescript type generator for openapi-client-axios

@arutkowski00/openapi-client-axios-typegen

3.14.1-patch.1

Typescript type generator for openapi-client-axios