https://github.com/v79/apiviaduct

A serverless RESTful API and router written in Kotlin for AWS Lambda
https://github.com/v79/apiviaduct

Last synced: 19 days ago
JSON representation

A serverless RESTful API and router written in Kotlin for AWS Lambda

• Host: GitHub
• URL: https://github.com/v79/apiviaduct
• Owner: v79
• Created: 2024-05-18T16:46:48.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-06-02T17:33:17.000Z (7 months ago)
• Last Synced: 2024-12-09T17:14:07.258Z (26 days ago)
• Language: Kotlin
• Size: 163 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# APIViaduct

A serverless RESTful API and router written in Kotlin for AWS Lambda

Inspired by my earlier project [Cantilever](https://www.cantilevers.org/), I wanted to create a more lightweight and flexible API framework for AWS Lambda. This project is a work in progress and is not yet ready for production use. This project will currently run on the JVM, and so has the inherent cold start issues of Java on AWS Lambda. I may explore GraalVM in the future as an alternative.

RESTful routes will be defined using a Kotlin DSL, and uses Kotlinx Serialization for JSON (de)serialization. The project is built using Gradle and the AWS SDK for Kotlin.

The library will support route grouping, authentication, all the main REST methods, and more. I hope to add an OpenAPI specification generator, and middleware our filters in the future. While the router defaults to JSON, it is possible to specify other content types such as text, YAML or any others supported by kotlinx.serialization.

## Example

```kotlin

  // a simple get request handler

  get("/hello") { _: Request ->

    Response.OK("Hello, world!")  

  }

  // a simple post request handler, expecting a JSON body for a data class of type 'Thingy'

  post("/new") { req: Request ->

    val body = req.body

    Response.OK("You sent: ${body.name}")

  }

```