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

serverless-api-version

v1.0.4

Published

CLI tool for versioning APIs on AWS Lambda

Downloads

5

Readme

What this package does

This package allows for trivial versioning of HTTP endpoints for Lambda functions using the Serverless framework. I'm not involved with Serverless development and any failings of this library reflect on me and not on Serverless. Additionally, this library is currently very much a WIP. There are no unit tests.

Assumptions

  • API releases correspond with Github releases
  • Single Github repository for all functions defined in the serverless.yml
  • API is versioned like 'v1', 'v2', etc.
  • Each release bundles all necessary files including the serverless.yml associated with each version.
  • That you aren't already using a ./releases folder.

Use case

If you have a series of endpionts that you don't want to force people to migrate, this CLI tool can enable API versioning without manually updating your serverless.yml.

How it works

Previous versions are downloaded into a ./releases folder. It then creates a combined serverless.yml file with versioning of the API endpoints.

Workflow

Go do your normal Lambda stuff. When you want to upgrade an API, use the CLI command serverless-api-version new. This will create a combined serverless.yml and packaged assets by version in the ./releases folder. You can set up your CI/CD tool to either automatically deploy on tagged commit or manually trigger a deploy.

Installation

npm install -g serverless-api-version

Use

serverless-api-version new to create a new release with new API endpoint. The CLI will handle creating a new tag, release, etc on the Github side.
serverless-api-version replace to replace the previous API version.