Skip to content

Latest commit

 

History

History
25 lines (16 loc) · 705 Bytes

README.md

File metadata and controls

25 lines (16 loc) · 705 Bytes

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.