@sencrop/openapi-js-sdk-builder

1.1.7 • Public • Published

@sencrop/openapi-js-sdk-builder

Create a JavaScript SDK from an OpenAPI 3 definition

Usage

With a raw Node script:

import { generateSDKFromOpenAPI } from 'openapi-js-sdk-builder';
import { readFileSync, writeFileSync } from 'fs';

const openAPIContents = readFileSync('openapi.json', 'utf-8');
const sdkContents = generateSDKFromOpenAPI(openAPIContents);

writeFileSync('sdk.js', sdkContents, 'utf-8');

You can also use the built-in webpack loader in your frontends builds:

In webpack.config.js:

module.exports = {
  //...
  module: {
    rules: [
      {
        test: /(\.|^)openapi.json$/,
        loader: require.resolve('openapi-js-sdk-builder'),
        type: 'javascript/auto'
      }
    ]
  }
};

In your code:

import API from './myapi.openapi.json'

// Just use the API then
await API.getPing();

Useful resources

License

MIT

Useful resources

License

MIT

/@sencrop/openapi-js-sdk-builder/

    Package Sidebar

    Install

    npm i @sencrop/openapi-js-sdk-builder

    Weekly Downloads

    12

    Version

    1.1.7

    License

    MIT

    Unpacked Size

    43.3 kB

    Total Files

    18

    Last publish

    Collaborators

    • cloedec
    • petitlepton
    • tleblan-sencrop
    • renaud.sencrop
    • rdelgatte
    • jeromesencrop
    • loanjanczaksencrop
    • clementhenichard
    • alexandreduhem
    • kevin-guilbert
    • troncin
    • oluane
    • cdelfabbro
    • vguilbaud3
    • fuzznimp
    • floriantz_sencrop
    • oupsla
    • dude059
    • mdespriee
    • florianlauer
    • paularnaud