LoopBack Swagger

@vsaas/loopback-swagger is a maintained fork of loopback-swagger for LoopBack 3 codebases.

This fork keeps the familiar helper surface while modernizing the package:

• TypeScript source in src/
• build output in dist/
• OpenAPI 3 runtime spec generation
• vitest, oxlint, oxfmt, and tsdown
• English-only messages without strong-globalize or intl/
• a smaller dependency surface

Installation

npm install @vsaas/loopback-swagger

Usage

Generate an OpenAPI 3 document from a LoopBack application:

const { generateSwaggerSpec } = require('@vsaas/loopback-swagger');

const spec = generateSwaggerSpec(app);

console.log(spec.openapi);
// 3.0.1

Generate LoopBack remoting metadata from a legacy Swagger spec:

const { generateModels, generateRemoteMethods } = require('@vsaas/loopback-swagger');

const models = generateModels(swaggerV2Spec);
const methods = generateRemoteMethods(swaggerV2Spec, {
  modelName: 'Pet',
});

Scope

This package currently supports:

• generateSwaggerSpec(app, options) for LoopBack 3 applications, returning an OpenAPI 3 document
• generateRemoteMethods(spec, options) for Swagger 1.2 and 2.0 input
• generateModels(spec, options) for Swagger 1.2, Swagger 2.0, and OpenAPI 3.x schema sources
• direct package entrypoints and compiled subpaths from dist/

The runtime spec generation path has been migrated to OpenAPI 3. The legacy Swagger 1.2 and 2.0 code generation helpers are still kept for compatibility.

Notes for Fork Users

• This is a fork, not the upstream loopback-swagger package.
• The package name is @vsaas/loopback-swagger.
• Test files remain plain .js.
• Published runtime code is exposed from dist/.

Development

npm run build
npm run typecheck
npm run lint
npm test

License

MIT. See LICENSE.