https://github.com/MarioSimou/serverless-offline-lambda-function-urls

https://github.com/MarioSimou/serverless-offline-lambda-function-urls

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/MarioSimou/serverless-offline-lambda-function-urls
• Owner: MarioSimou
• Created: 2023-04-18T19:36:46.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-12-01T19:42:58.000Z (10 months ago)
• Last Synced: 2024-07-19T01:01:16.756Z (2 months ago)
• Language: JavaScript
• Size: 141 KB
• Stars: 3
• Watchers: 1
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Serverless Offline - Lambda Function Urls

## Description

This plugin provides a temporal solution to the issue described [here](https://github.com/dherault/serverless-offline/issues/1382).

### Setup

1. Inside your project's `serverless.yml` file, add the following entry in the `plugins` section.

```yaml

plugins:

  - serverless-offline

  - serverless-offline-lambda-function-urls

```

2. Configure the port where the new server will be running. By default, the server will run on 3003.

```yaml

serverless-offline:

  urlLambdaFunctionsHttpPort: 3003

  # Optional - choose which HTTP verb(s) to enable. If omitted, GET and POST will be enabled

  urlLambdaFunctionsHttpVerbs:

    - GET

    - DELETE

```

3. 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.

```yaml

ping:

  handler: ./src/functions/ping.handler

  url: true

  timeout: 120 # The handler will timeout after 2 minutes and API Gateway won't interrupt it

```

4. Run `serverless offline` and the plugin will be triggerred by the `offline:start:init` event.

```bash

serverless offline start

```