vapor-aws-lambda-runtime

KO | EN

gitlite — search

#javascript #python #hacktoberfest #llm #go #rust #deep-learning #docker #nodejs #java #awesome-list #vue #pytorch #open-source

vapor-aws-lambda-runtime

(★ 105)

Run your Vapor api server on AWS Lambda using the official Swift Server runtime.

vapor-aws-lambda-runtime Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# vapor-aws-lambda-runtime

[![Swift 5.2](https://img.shields.io/badge/Swift-5.2-blue.svg)](https://swift.org/download/)
[![Vapor 4](https://img.shields.io/badge/Vapor-4-5AA9E7.svg)](https://raw.githubusercontent.com/vapor-community/vapor-aws-lambda-runtime/main/vapor/vapor)
[![github-actions](https://github.com/fabianfett/vapor-lambda-runtime/workflows/CI/badge.svg)](https://github.com/fabianfett/vapor-lambda-runtime/actions)
[![codecov](https://codecov.io/gh/fabianfett/vapor-lambda-runtime/branch/main/graph/badge.svg)](https://codecov.io/gh/fabianfett/vapor-lambda-runtime)

Run your Vapor app on AWS Lambda. This package bridges the communication between [`swift-aws-lambda-runtime`](https://github.com/swift-server/swift-aws-lambda-runtime)
and the [Vapor](https://github.com/vapor/vapor) framework. APIGateway requests are transformed into `Vapor.Request`s and `Vapor.Response`s are written back to the APIGateway. It intents to bring the funcionality of [`aws-lambda-go-api-proxy`](/awslabs/aws-lambda-go-api-proxy) to Vapor.

## Status

**Note: Currently this is nothing more than a proof of concept. Use at your own risk. I would like to hear feedback, if you played with this. Please open a GitHub issues for all open ends, you experience.**

What I have tested:

- [x] Routing
- [x] JSON Coding
- [ ] Cors Middleware
- [ ] Fluent

There are probably tons of other things that we should test. I haven't done much with Vapor so far. Therefore you will need to help me list the things to test.

Examples:

- [HelloWorld](examples/Hello/Sources/Hello/main.swift)

If you test anything, please open a PR so that we can document the state of affairs better. A super small example would be even better. I plan to create some integration tests with the examples.

## Usage

Add `vapor-aws-lambda-runtime` and `vapor` as dependencies to your project. For this open your `Package.swift`:

```swift
  dependencies: [
    .package(url: "https://github.com/vapor/vapor.git", .upToNextMajor(from: "4.0.0")),
    .package(url: "https://github.com/fabianfett/vapor-aws-lambda-runtime", .upToNextMajor(from: "0.4.0")),
  ]
```

Add VaporLambdaRuntime as depency to your target:

```swift
  targets: [
    .target(name: "Hello", dependencies: [
      .product(name: "Vapor", package: "vapor"),
      .product(name: "VaporAWSLambdaRuntime", package: "vapor-aws-lambda-runtime")
    ]),
  ]
```

Create a simple Vapor app.

```swift
import Vapor
import VaporAWSLambdaRuntime

let app = Application()

struct Name: Codable {
  let name: String
}

struct Hello: Content {
  let hello: String
}

app.get("hello") { (_) -> Hello in
  Hello(hello: "world")
}

app.post("hello") { req -> Hello in
  let name = try req.content.decode(Name.self)
  return Hello(hello: name.name)
}
```

Next we just need to run the vapor app. To enable running in Lambda, we need to change the "serve" command. Then we can start the app by calling `app.run()`

```swift
app.servers.use(.lambda)

try app.run()
```

## Contributing

Please feel welcome and encouraged to contribute to vapor-aws-lambda-runtime. The current version has a long way to go before being ready for production use and help is always welcome.

If you've found a bug, have a suggestion or need help getting started, please open an Issue or a PR. If you use this package, I'd be grateful for sharing your experience.

If you like this project, I'm excited about GitHub stars. 🤓

vapor-aws-lambda-runtime

vapor-aws-lambda-runtime Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

vapor-aws-lambda-runtime

vapor-aws-lambda-runtime Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README