客服电话
APP下载
迪恩网络APP
随时随地掌握行业动态
官方微信
扫描二维码
关注迪恩网络微信公众号
开源软件名称：jeremydaly/lambda-api开源软件地址：https://github.com/jeremydaly/lambda-api开源编程语言：JavaScript 100.0%开源软件介绍：
Lightweight web framework for your serverless applicationsLambda API is a lightweight web framework for AWS Lambda using AWS API Gateway Lambda Proxy Integration or ALB Lambda Target Support. This closely mirrors (and is based on) other web frameworks like Express.js and Fastify, but is significantly stripped down to maximize performance with Lambda's stateless, single run executions. Simple Example// Require the framework and instantiate it
const api = require('lambda-api')();
// Define a route
api.get('/status', async (req, res) => {
return { status: 'ok' };
});
// Declare your Lambda handler
exports.handler = async (event, context) => {
// Run the request
return await api.run(event, context);
};For a full tutorial see How To: Build a Serverless API with Serverless, AWS Lambda and Lambda API. Why Another Web Framework?Express.js, Fastify, Koa, Restify, and Hapi are just a few of the many amazing web frameworks out there for Node.js. So why build yet another one when there are so many great options already? One word: DEPENDENCIES. These other frameworks are extremely powerful, but that benefit comes with the steep price of requiring several additional Node.js modules. Not only is this a bit of a security issue (see Beware of Third-Party Packages in Securing Serverless), but it also adds bloat to your codebase, filling your Lambda API has ZERO dependencies. None. Zip. Zilch. Lambda API was written to be extremely lightweight and built specifically for SERVERLESS applications using AWS Lambda and API Gateway. It provides support for API routing, serving up HTML pages, issuing redirects, serving binary files and much more. Worried about observability? Lambda API has a built-in logging engine that can even periodically sample requests for things like tracing and benchmarking. It has a powerful middleware and error handling system, allowing you to implement just about anything you can dream of. Best of all, it was designed to work with Lambda's Proxy Integration, automatically handling all the interaction with API Gateway for you. It parses REQUESTS and formats RESPONSES, allowing you to focus on your application's core functionality, instead of fiddling with inputs and outputs. Single Purpose FunctionsYou may have heard that a serverless "best practice" is to keep your functions small and limit them to a single purpose. I generally agree since building monolith applications is not what serverless was designed for. However, what exactly is a "single purpose" when it comes to building serverless APIs and web services? Should we create a separate function for our "create user" Whatever you decide is best for your use case, Lambda API is there to support you. Whether your function has over a hundred routes, or just one, Lambda API's small size and lightning fast load time has virtually no impact on your function's performance. You can even define global wildcard routes that will process any incoming request, allowing you to use API Gateway or ALB to determine the routing. Yet despite its small footprint, it gives you the power of a full-featured web framework. Table of Contents
InstallationRequirements
ConfigurationRequire the
// Require the framework and instantiate it with optional version and base parameters
const api = require('lambda-api')({ version: 'v1.0', base: 'v1' });Recent UpdatesFor detailed release notes see Releases. v0.11: API Gateway v2 payload support and automatic compressionLambda API now supports API Gateway v2 payloads for use with HTTP APIs. The library automatically detects the payload, so no extra configuration is needed. Automatic compression has also been added and supports Brotli, Gzip and Deflate. v0.10: ALB support, method-based middleware, and multi-value headers and query string parametersLambda API now allows you to seamlessly switch between API Gateway and Application Load Balancers. New execution stacks enables method-based middleware and more wildcard functionality. Plus full support for multi-value headers and query string parameters. Routes and HTTP MethodsRoutes are defined by using convenience methods or the Multiple handler functions can be assigned to a path, which can be used to execute middleware for specific paths and methods. For more information, see Middleware and Execution Stacks. Examples using convenience route methods: api.get('/users', (req,res) => {
// do something
})
api.post('/users', (req,res) => {
// do something
})
api.delete('/users', (req,res) => {
// do something
})
api.get('/users',
(req,res,next) => {
// do some middleware
next() // continue execution
}),
(req,res) => {
// do something
}
)
api.post((req,res) => {
// do something for ALL post requests
})Additional methods are support by calling api.METHOD('trace','/users', (req,res) => {
// do something on TRACE
})
api.METHOD(['post','put'],'/users', (req,res) => {
// do something on POST -or- PUT
})
api.METHOD('get','/users',
(req,res,next) => {
// do some middleware
next() // continue execution
}),
(req,res) => {
// do something
}
)All Routes that use the api.any('/users', (req, res) => {
res.send('any');
});
api.get('/users', (req, res) => {
res.send('get');
});A Returning ResponsesLambda API supports both api.get('/users', (req, res) => {
res.send({ foo: 'bar' });
});You can also api.get('/users', (req, res) => {
return { foo: 'bar' };
});Async/AwaitIf you prefer to use Using api.get('/users', async (req, res) => {
let users = await getUsers();
return users;
});Or using callbacks: api.get('/users', async (req, res) => {
let users = await getUsers();
res.send(users);
});PromisesIf you like promises, you can either use a callback like api.get('/users', (req, res) => {
getUsers().then((users) => {
res.send(users);
});
});OR api.get('/users', (req, res) => {
return getUsers().then((users) => {
return users;
});
});IMPORTANT: You must either use a callback like A Note About Flow ControlWhile callbacks like api.get('/users', (req, res) => {
if (req.headers.test === 'test') {
res.error('Throw an error');
}
return { foo: 'bar' };
});The example above would not have the intended result of displaying an error. api.get('/users', (req, res) => {
if (req.headers.test === 'test') {
return res.error('Throw an error');
}
return { foo: 'bar' };
});
Route PrefixingLambda API makes it easy to create multiple versions of the same api without changing routes by hand. The // handler.js
const api = require('lambda-api')();
api.register(require('./routes/v1/products'), { prefix: '/v1' });
api.register(require('./routes/v2/products'), { prefix: '/v2' });
module.exports.handler = (event, context, callback) => {
api.run(event, context, callback);
};// routes/v1/products.js
module.exports = (api, opts) => {
api.get('/product', handler_v1);
};// routes/v2/products.js
module.exports = (api, opts) => {
api.get('/product', handler_v2);
};Even though both modules create a
You can use module.exports = (api, opts) => {
api.get('/product', handler_v1);
api.register(require('./v2/products.js'), { prefix: '/v2' });
};This would create a Debugging RoutesLambda API has a const api = require('lambda-api')();
api.get('/', (req, res) => {});
api.post('/test', (req, res) => {});
api.routes(); // => [ [ 'GET', '/' ], [ 'POST', '/test' ] ]You can also log the paths in table form to the console by passing in const api = require('lambda-api')()
api.get('/', (req,res) => {})
api.post('/test', (req,res) => {})
api.routes(true)
// Outputs to console
╔═══════════╤═════════════════╗
║ METHOD │ ROUTE ║
╟───────────┼─────────────────╢
║ GET │ / ║
╟───────────┼─────────────────╢
║ POST │ /test ║
╚═══════════╧═════════════════╝
全部评论
专题导读
上一篇：EhsanTang/ApiManager: CRAP - 开源API接口管理平台 | 完全开源、免费使用的API接口管 ...发布时间：2022-04-03下一篇：brutasse/graphite-api: Graphite-web, without the interface. Just the rendering H ...发布时间：2022-04-03热门推荐
热门话题
 阅读排行榜
|
请发表评论