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.
Thank you to Upstash for reaching out to sponsor this project!
|
(* Experimental)
- Node (http.createServer)
- Connect
- Express
- Koa
- Restana
- Sails *
- Hapi *
- Fastify *
- Restify *
- Polka *
- Loopback *
- AWS
- Azure (Experimental, untested, probably outdated)
Please check the examples folder!
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;
};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);
}json-server-less-ฮป - using serverless-http with json-server and serverless framework in AWS
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.
Pull requests are welcome! Especially test scenarios for different situations and configurations.
Here are some more detailed examples and advanced configuration options as well as provider-specific documentation