1.0.0-next.1 • Published 4 years ago

express-versioned-route v1.0.0-next.1

Weekly downloads
2
License
Apache-2.0
Repository
github
Last release
4 years ago

Express-Versioned-Route

Simple express.js 4.x extension, to add support for versioned routes.

Maintainability Rating Security Rating Quality Gate Status GitHub issues GitHub issues-closed

Technical Debt Vulnerabilities Bugs Code Smells Duplicated Lines (%) Lines of Code

Highlights

  • Versioning the same route
  • Loading time validation
  • Custom middlewares for each version
  • Built-in soft deprecation policy (to be added soon)
  • Case insensitive name matching
  • Minimal overhead ( less than 0.15ms/request )
  • Dynamic routing based on client headers
  • Client can choose the version using accept-version header

Install

npm install express-versioned-route

Usage

const searchVersionDef = versionsDef({
  versions: {
    simpleSearch: ['2020-Q1', searchMW1, searchMW2, searchHandlerV1],
    dynamicSearch: [dynamicSearchMW1, dynamicSearchMW2, searchHandlerV2],
    superSearch: [searchHandlerV3],
    deepSearch: [searchHandlerV4],
  },
  Android: [
    [400, 'simpleSearch'],
    [450, 'dynamicSearch'],
    [500, 'superSearch'],
  ],
  iOS: [
    [400, 'simpleSearch'],
    [460, 'dynamicSearch'],
  ],
});

app.get('/search', mw1, mw2, searchVersionDef);

License

Apache-2.0