Skip to content
Opinionated OpenAPI (Swagger) Client
Branch: develop
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
.globality
example
src
.babelrc
.bumpversion.cfg
.eslintrc
.gitignore
.npmrc
LICENSE
README.md
package.json
yarn.lock

README.md

nodule-openapi

Opinionated OpenAPI 2.0 (Swagger) Client

Conventions

  • Client code should be lightweight (e.g. few dependencies) and initialize quickly (read: synchronously)

    As such, OpenAPI specs are expected to be available locally (e.g. commited to version control) and loaded statically (i.e. without requiring promise resolution).

  • Client interfaces should use fluent JavaScript.

    As of this writing, OpenAPI operations are exposed as functions named after operationId, scoped to an an object named after the operation's first tag. (Both operation fields are thus mandatory).

  • HTTP requests are assumed to use camelCase for body parameters and snake_case for path and query string parameters; parameter names should be automatically converted from camelCase accordingly.

  • Extensible most default: most internal behaviors should be overridable via options.

Usage

In pseudo-code:

const OpenAPI = require('./lib').default;
const spec = require('./example/petstore-minimal.json');

const client = OpenAPI(spec, 'petstore');
client.pet.search().then(...).catch(...);

createOpenAPIClient

The nodule-openapi includes a function (createOpenAPIClient) that allows the wrapping of the OpenAPI swagger client into callable functions. See the README in the src/clients for more information.

You can’t perform that action at this time.