Serverless Base Path Plugin - Set a base API path for all function endpoints.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore
README.md
index.js
package.json

README.md

Serverless Base Path Plugin

This is a Serverless plugin for setting a base path for all API Gateway endpoints in a Component.

Usage

Prefix Endpoint paths on deploy by adding the basePath to the custom Object in s-component.json.

Example s-project.json

"custom": {
    "basePath" : "test/base/path/"
  },

Keep in mind that currently it may take multiple deploys to work properly and any pre-existing endpoints will remain.

TODO

  • Detect changes to the basePath value and update Endpoints as needed.
  • Project level custom key support.
  • Module level custom key support.
  • Automatically add a trailing / if its missing from the basePath.