Magical SDK generation from an OpenAPI definition 🪄

• Installation
• Usage
  • Authentication
  • Parameters and Payloads
  • Making requests
  • Server configurations
• How does it work?
• FAQ

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

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

The ESM syntax is supported as well:

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