Package Exports

@sleeksky/alt-swagger
@sleeksky/alt-swagger/src/index.js

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 (@sleeksky/alt-swagger) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Spec API

Quickly spec your APIs for Swagger / OpenAPI interface. Uses @sleeksky/alt-schema for specifying JSON schema.

Example

let refRequest = docs.ref.schema('example','{id:i:1,name:s:foo,label:{id:i:2,name:?s:bar},arr:[{a🅱️false}]}');

docs.put('/:id').tag("dot-notation").req(refRequest).res(200, '{hello,world}');

Installation

npm install -s @sleeksky/alt-swagger

const docs = require('@sleeksky/alt-swagger');

Usage

See example.js

@sleeksky/alt-swagger