Skip to content

readmeio/api

Repository files navigation

Magical SDK generation from an OpenAPI definition 🪄

NPM Version Node Version MIT License Build status

api is a library that facilitates creating an SDK from an OpenAPI definition. You can use its codegen offering to create an opinionated SDK for TypeScript or JS (+ TypeScript types).

$ npx api install https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.json
const petstore = require('@api/petstore');

petstore.listPets().then(({ data }) => {
  console.log(`My pets name is ${data[0].name}!`);
});

The ESM syntax is supported as well:

import petstore from '@api/petstore';

petstore.listPets().then(({ data }) => {
  console.log(`My pets name is ${data[0].name}!`);
});