Package Exports

@loopback/openapi-spec

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

Readme

@loopback/openapi-spec

TypeScript type definitions for OpenAPI Spec/Swagger documents.

Overview

TypeScript definitions describing the schema of OpenAPI/Swagger documents, including LoopBack-specific extensions.

Installation

$ npm install --save @loopback/openapi-spec

Basic use

Use OpenApiSpec type in your function accepting a Swagger/OpenAPI document:

import {OpenApiSpec} from '@loopback/openapi-spec';

export function validateSpec(spec: OpenApiSpec) {
  // ...
}

IDEs like Visual Studio Code will offer auto-completion for spec properties when constructing a spec argument value.

See https://www.openapis.org/ and version 2.0 of OpenAPI Specification.

Contributions

IBM/StrongLoop is an active supporter of open source and welcomes contributions to our projects as well as those of the Node.js community in general. For more information on how to contribute please refer to the Contribution Guide.

Tests

run npm test from the root folder.

Contributors

See all contributors.

License

MIT