![\"openapi-client-axios\"](\"./header.png\")
JavaScript client library for consuming OpenAPI-enabled APIs with axios. Types included.
\n\n## Features\n\n- [x] Create API clients from [OpenAPI v3 definitions](https://github.com/OAI/OpenAPI-Specification)\n- [x] Easy to use API to call API operations using JavaScript methods\n - `client.getPet(1)`\n - `client.searchPets()`\n - `client.searchPets({ ids: [1, 2, 3] })`\n - `client.updatePet(1, payload)`\n- [x] Built on top of the robust [axios](https://github.com/axios/axios) JavaScript library\n- [x] Isomorphic, works both in browser and Node.js\n- [x] Generate TypeScript definitions (.d.ts) for your APIs with full IntelliSense support\n\n## Documentation\n\nSee [DOCS.md](https://github.com/anttiviljami/openapi-client-axios/blob/master/DOCS.md)\n\n## Quick Start\n\n```\nnpm install --save axios openapi-client-axios\n```\n\n```\nyarn add axios openapi-client-axios\n```\n\nWith promises / CommonJS syntax:\n\n```javascript\nconst OpenAPIClientAxios = require('openapi-client-axios').default;\n\nconst api = new OpenAPIClientAxios({ definition: 'https://example.com/api/openapi.json' });\napi.init()\n .then(client => client.getPetById(1))\n .then(res => console.log('Here is pet id:1 from the api', res.data));\n```\n\nWith async-await / ES6 syntax:\n\n```javascript\nimport OpenAPIClientAxios from 'openapi-client-axios';\n\nconst api = new OpenAPIClientAxios({ definition: 'https://example.com/api/openapi.json' });\napi.init();\n\nasync function createPet() {\n const client = await api.getClient();\n const res = await client.createPet(null, { name: 'Garfield' });\n console.log('Pet created', res.data);\n}\n```\n\n## Client\n\nOpenAPI Client Axios uses [operationIds](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#operation-object)\nin OpenAPIv3 definitions to call API operations.\n\nAfter initializing `OpenAPIClientAxios`, an axios client instance extended with OpenAPI capabilities is exposed.\n\nExample:\n```javascript\nconst api = new OpenAPIClientAxios({ definition: 'https://example.com/api/openapi.json' });\napi.init().then((client) => {\n client.updatePet(1, { age: 12 });\n});\n```\n\n`client` is an [axios instance](https://github.com/axios/axios#creating-an-instance) initialized with\nbaseURL from OpenAPI definitions and extended with extra operation methods for calling API operations.\n\nIt also has a reference to OpenAPIClientAxios at `client.api`\n\n## Operation methods\n\nOpenAPIClientAxios operation methods take 3 arguments:\n\n```javascript\nclient.operationId(parameters?, data?, config?)\n```\n\n### Parameters\n\nThe first argument is used to pass parameters available for the operation.\n\n```javascript\n// GET /pets/{petId}\nclient.getPet({ petId: 1 })\n```\n\nFor syntactic sugar purposes, you can also specify a single implicit parameter value, in which case OpenAPIClientAxios\nwill look for the first required parameter for the operation. Usually this is will be a path parameter.\n\n```javascript\n// GET /pets/{petId} - getPet\nclient.getPet(1)\n```\n\nAlternatively, you can explicitly specify parameters in array form. This method allows you to set custom parameters not defined\nin the OpenAPI spec.\n\n```javascript\n// GET /pets?search=Garfield - searchPets\nclient.searchPets([{ name: 'search', value: 'Garfield', in: 'query' }])\n```\n\nThe type of the parameters can be any of:\n- query\n- header\n- path\n- cookie\n\n### Data\n\nThe second argument is used to pass the requestPayload\n\n```javascript\n// PUT /pets/1 - updatePet\nclient.updatePet(1, { name: 'Odie' })\n```\n\nMore complex payloads, such as Node.js streams or FormData supported by Axios can be used.\n\nThe first argument can be set to null if there are no parameters required for the operation.\n\n```javascript\n// POST /pets - createPet\nclient.updatePet(null, { name: 'Garfield' })\n```\n\n### Config object\n\nThe last argument is the config object.\n\nThe config object is an [`AxiosRequestConfig`](https://github.com/axios/axios#request-config) object. You can use it to\noverride axios request config parameters, such as `headers`, `timeout`, `withCredentials` and many more.\n\n```javascript\n// POST /user - createUser\nclient.createUser(null, { user: 'admin', pass: '123' }, { headers: { 'x-api-key': 'secret' } });\n```\n\n## Paths Dictionary\n\nOpenAPI Client Axios also allows calling API operations via their path and HTTP\nmethod, using the paths dictionary.\n\nExample:\n\n```javascript\nclient.paths['/pets'].get(); // GET /pets, same as calling client.getPets()\nclient.paths['/pets'].post(); // POST /pets\nclient.paths['/pets/{petId}'].put(1); // PUT /pets/1\nclient.paths['/pets/{petId}/owner/{ownerId}'].get({ petId: 1, ownerId: 2 }) ; // GET /pets/1/owner/2\n```\n\nThis allows calling operation methods without using their operationIds, which\nmay be sometimes preferred.\n\n## Generating type files (.d.ts)\n\n\n\n`openapi-client-axios` comes with a tool called `typegen` to generate typescript type files (.d.ts) for\nOpenAPIClient instances using an OpenAPI definition file.\n\n```\n$ npm install -g openapi-client-axios-typegen\n```\n\n```\nUsage: typegen [file]\n\nOptions:\n --help Show help [boolean]\n --version Show version number [boolean]\n\nExamples:\n typegen ./openapi.yml > client.d.ts - generate a type definition file\n```\n\nThe output of `typegen` exports a type called `Client`, which can be used for instances created with `OpenAPIClientAxios`.\n\nBoth the `api.getClient()` and `api.init()` methods support passing in a Client type.\n\n```typescript\nimport { Client as PetStoreClient } from './client.d.ts';\n\nconst client = await api.init![\"The](\"http://spiceprogram.org/assets/img/chilicorn_sticker.svg\")
](https://spiceprogram.org/oss-sponsorship)\n\n","readmeFilename":"README.md"}