https://github.com/openapistack/openapi-client-axios

JavaScript client library for consuming OpenAPI-enabled APIs with axios
https://github.com/openapistack/openapi-client-axios

axios hacktoberfest openapi swagger typescript

Last synced: about 2 months ago
JSON representation

JavaScript client library for consuming OpenAPI-enabled APIs with axios

• Host: GitHub
• URL: https://github.com/openapistack/openapi-client-axios
• Owner: openapistack
• License: mit
• Created: 2018-11-17T11:04:15.000Z (almost 6 years ago)
• Default Branch: main
• Last Pushed: 2024-02-29T20:11:19.000Z (7 months ago)
• Last Synced: 2024-04-15T02:09:03.692Z (5 months ago)
• Topics: axios, hacktoberfest, openapi, swagger, typescript
• Language: TypeScript
• Homepage: https://openapistack.co
• Size: 2.87 MB
• Stars: 494
• Watchers: 6
• Forks: 64
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


[![CI](https://github.com/openapistack/openapi-client-axios/workflows/CI/badge.svg)](https://github.com/openapistack/openapi-client-axios/actions?query=workflow%3ACI)

[![License](http://img.shields.io/:license-mit-blue.svg)](https://github.com/openapistack/openapi-client-axios/blob/main/LICENSE)

[![npm version](https://img.shields.io/npm/v/openapi-client-axios.svg)](https://www.npmjs.com/package/openapi-client-axios)

[![npm downloads](https://img.shields.io/npm/dw/openapi-client-axios.svg)](https://www.npmjs.com/package/openapi-client-axios)

[![bundle size](https://img.shields.io/bundlephobia/minzip/openapi-client-axios.svg?label=gzip%20bundle)](https://bundlephobia.com/package/openapi-client-axios)

[![Libraries.io dependency status for latest release](https://img.shields.io/librariesio/release/npm/openapi-client-axios.svg)](https://www.npmjs.com/package/openapi-client-axios?activeTab=dependencies)

![npm type definitions](https://img.shields.io/npm/types/openapi-client-axios.svg)

[![Buy me a coffee](https://img.shields.io/badge/donate-buy%20me%20a%20coffee-orange)](https://buymeacoff.ee/anttiviljami)

JavaScript client library for consuming OpenAPI-enabled APIs with axios. Types included.


## Features

- [x] Create API clients from [OpenAPI v3 definitions](https://github.com/OAI/OpenAPI-Specification)

- [x] Client is configured in runtime. **No generated code!**

- [x] Generate TypeScript definitions (.d.ts) for your APIs with full IntelliSense support

- [x] Easy to use API to call API operations using JavaScript methods

  - `client.getPet(1)`

  - `client.searchPets()`

  - `client.searchPets({ ids: [1, 2, 3] })`

  - `client.updatePet(1, payload)`

- [x] Built on top of the robust [axios](https://github.com/axios/axios) JavaScript library

- [x] Isomorphic, works both in browser and Node.js

## Documentation

**New!** OpenAPI Client Axios documentation is now found on [openapistack.co](https://openapistack.co)

https://openapistack.co/docs/openapi-client-axios/intro

## Quick Start

```

npm install --save axios openapi-client-axios

```

```

yarn add axios openapi-client-axios

```

With promises / CommonJS syntax:

```javascript

const OpenAPIClientAxios = require('openapi-client-axios').default;

const api = new OpenAPIClientAxios({ definition: 'https://example.com/api/openapi.json' });

api.init()

  .then(client => client.getPetById(1))

  .then(res => console.log('Here is pet id:1 from the api', res.data));

```

With async-await / ES6 syntax:

```javascript

import OpenAPIClientAxios from 'openapi-client-axios';

const api = new OpenAPIClientAxios({ definition: 'https://example.com/api/openapi.json' });

api.init();

async function createPet() {

  const client = await api.getClient();

  const res = await client.createPet(null, { name: 'Garfield' });

  console.log('Pet created', res.data);

}

```

## Typesafe Clients

![TypeScript IntelliSense](https://github.com/openapistack/openapi-client-axios/blob/main/packages/typegen/intellisense.gif)

`openapi-client-axios` comes with a CLI command `openapicmd typegen` to generate Typescript types for type safety and code autocomplete.

```

npx openapicmd typegen ./openapi.yaml > src/types/openapi.d.ts

```

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.

```typescript

import { Client as PetStoreClient } from './client.d.ts';

const client = await api.init();

const client = await api.getClient();

```

`openapicmd typegen` supports using both local and remote URLs for OpenAPI definition files.

```

$ npx openapicmd typegen ./petstore.yaml

$ npx openapicmd typegen https://petstore3.swagger.io/api/v3/openapi.json

```

## Commercial support

For assistance with openapi-client-axios in your company, reach out at [email protected].

## Contributing

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