npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@cmsgov/qpp-shared-api-versioning-node

v1.1.3

Published

CMS QPP specific express middleware to get version from Accept header and put it on the request object

Downloads

853

Readme

qpp-shared-api-versioning-node

Build - PR

This package provides ExpressJS middleware that parses incoming HTTP headers to determine the type and version of the API to be consumed. It sets a apiVersion and format property on the req object.

The library will parse the version from the Accept header, expecting the following format:

Accept: application/vnd.qpp.cms.gov.v1+json

or

Accept: application/vnd.qpp.cms.gov.v123+xml

or

Accept: application/vnd.qpp.cms.gov.v123

Requirements

node v10.15.x or higher

Usage

Set request version by 'Accept' header

const requestVersion = require('@cmsgov/qpp-shared-api-versioning-node');

app.use(requestVersion.setVersion());

Options

const options = {
  defaultFormat: 'json'
  defaultVersion: 1,
  supportedVersions: [1, 2]
};

You can pass a defaultFormat to set a format if none are passed. Note: This will only be set if the format in the Accept header of the request matches xml or json.

You can pass in a defaultVersion value on options to set the default version if there is no version in the Accept header of the request:

app.use(requestVersion.setVersion({ defaultVersion: 1 }));

If you pass in a supportedVersions array on options the requested version does not exist in the array, then the defualt version will be set.

Downstream

If you define a middleware after requestVersion then you can verify that the version is indeed set:

app.use((req, res, next) => {
  console.log(req.apiVersion);
  console.log(req.format);
  next();
});

Installation

npm install @cmsgov/qpp-shared-api-versioning-node

Tests

npm test

Project linting:

npm run lint

Coverage

npm run test:coverage

Want to Contribute?

Want to file a bug or contribute some code? Read up on our guidelines for contributing.

Public Domain

This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.

All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.

See the formal LICENSE file.

Resources