Skip to content

scoville/serverless-offline-lambda-function-urls

 
 

Repository files navigation

Serverless Offline - Lambda Function Urls

Description

This plugin provides a temporal solution to the issue described here.

Setup

  1. Inside your project's serverless.yml file, add the following entry in the plugins section.
plugins:
  - serverless-offline
  - serverless-offline-lambda-function-urls
  1. Configure the port where the new server will be running. By default, the server will run on 3003.
serverless-offline:
  urlLambdaFunctionsHttpPort: 3003

  # Optional - choose which HTTP verb(s) to enable. If omitted, GET and POST will be enabled
  urlLambdaFunctionsHttpVerbs:
    - GET
    - DELETE
  1. Configure a lambda url function. When you add the url option, the handler will expose it as an HTTP endpoint(/dev/ping) with the verbs specified in urlLambdaFunctionsHttpVerbs or GET and POST if that setting is not specified. The HTTP endpoint doesn't go through the API Gateway, which means that you can set your own timeout and it will respect it. Traditionally, the API Gateway would timeout after 30 seconds.
ping:
  handler: ./src/functions/ping.handler
  url: true
  timeout: 120 # The handler will timeout after 2 minutes and API Gateway won't interrupt it
  1. Run serverless offline and the plugin will be triggerred by the offline:start:init event.
serverless offline start

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 88.4%
  • TypeScript 11.6%