# serverless-http **Repository Path**: serverless-devs/serverless-http ## Basic Information - **Project Name**: serverless-http - **Description**: Use your existing middleware framework (e.g. Express, Koa) in AWS Lambda 🎉 - **Primary Language**: Unknown - **License**: MIT - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2022-04-20 - **Last Updated**: 2024-05-29 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # serverless-http [![Build Status](https://travis-ci.org/dougmoscrop/serverless-http.svg?branch=master)](https://travis-ci.org/dougmoscrop/serverless-http) ## 2.0 The 2.0 release moves to async/await and requires Node 8+. All frameworks have been updated to their latest versions. ## Description This module allows you to 'wrap' your API for serverless use. No HTTP server, no ports or sockets. Just your code in the same execution pipeline you are already familiar with. ## Support ### Supported Frameworks (* Experimental) * Connect * Express * Koa * Restana * Sails * * Hapi * * Fastify * * Restify * * Polka * * Loopback * ### Supported Providers * AWS * Azure (Experimental, untested, probably outdated) ## Examples Please check the `examples` folder! ### Usage example using the Koa framework ```javascript const serverless = require('serverless-http'); const Koa = require('koa'); // or any supported framework const app = new Koa(); app.use(/* register your middleware as normal */); // this is it! module.exports.handler = serverless(app); // or as a promise const handler = serverless(app); module.exports.handler = async (event, context) => { // you can do other things here const result = await handler(event, context); // and here return result; }; ``` ### Usage example using the Express framework with Azure ```javascript const serverless = require('serverless-http'); const express = require('express'); const app = express(); app.use(/* register your middleware as normal */); const handler = serverless(app, { provider: 'azure' }); module.exports.funcName = async (context, req) => { context.res = await handler(context, req); } ``` ### Other examples [json-server-less-λ](https://github.com/pharindoko/json-server-less-lambda) - using serverless-http with json-server and serverless framework in AWS ## Limitations Your code is running in a serverless environment. You cannot rely on your server being 'up' in the sense that you can/should not use in-memory sessions, web sockets, etc. You are also subject to provider specific restrictions on request/response size, duration, etc. > Think of this as a familiar way of expressing your app logic, *not* trying to make serverless do something it cannot. ## Contributing Pull requests are welcome! Especially test scenarios for different situations and configurations. ## Further Reading Here are some [more detailed examples](./docs/EXAMPLES.md) and [advanced configuration options](./docs/ADVANCED.md) as well as [provider-specific documentation](./docs/PROVIDERS.md)