api

Magical SDK generation from an OpenAPI definition 🪄

• Installation
• Usage
  • Authentication
  • Parameters and Payloads
  • HTTP 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@beta install https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.json

const SDK = require('@api/petstore');

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

📘

Please note that using api through npx is currently only available on the v5 beta that we're still working on. If you're using v4 or sooner the dynamic usage documentation pertains to you.

Or you can use it dynamically (though you won't have fancy TypeScript types):

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

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

Built With

• javascript
• shell
• typescript