JSPM

  • Created
  • Published
  • Downloads 68349
  • Score
    100M100P100Q130183F
  • License MIT

Magical SDK generation from an OpenAPI definition 🪄

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (api) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    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 api from 'api';
    const petstore = api('@petstore/v1.0#tl1e4kl1cl8eg8');
    
    petstore.listPets().then(({ data }) => {
      console.log(`My pets name is ${data[0].name}!`);
    });