Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yvele/azure-function-express
⚡️Allows Express.js usage with Azure Functions
https://github.com/yvele/azure-function-express
azure azure-functions azure-webjobs-sdk expressjs serverless
Last synced: 5 days ago
JSON representation
⚡️Allows Express.js usage with Azure Functions
- Host: GitHub
- URL: https://github.com/yvele/azure-function-express
- Owner: yvele
- License: apache-2.0
- Created: 2016-11-02T10:51:32.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-07-03T09:14:55.000Z (over 1 year ago)
- Last Synced: 2024-12-28T13:12:07.016Z (12 days ago)
- Topics: azure, azure-functions, azure-webjobs-sdk, expressjs, serverless
- Language: JavaScript
- Homepage:
- Size: 167 KB
- Stars: 169
- Watchers: 10
- Forks: 49
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-serverless - azure-functions-express - Allows Express.js usage with Azure Functions. (Frameworks)
README
# azure-function-express
> Allows Express usage with Azure Function
[](https://www.npmjs.com/package/azure-function-express)
[](https://github.com/Azure/azure-webjobs-sdk-script/issues/2036#issuecomment-336942961)
[](https://travis-ci.org/yvele/azure-function-express)
[](https://codecov.io/github/yvele/azure-function-express)
[](LICENSE)
## Description
[Connect](https://github.com/senchalabs/connect) your [Express](https://expressjs.com) application to an [Azure Function handler](https://docs.microsoft.com/en-us/azure/azure-functions/functions-reference-node), and make seamless usage of [all middlewares](http://expressjs.com/en/guide/using-middleware.html) you are already familiar with.
## Usage
In your `index.js`:
```js
const createHandler = require("azure-function-express").createHandler;
const express = require("express");
// Create express app as usual
const app = express();
app.get("/api/:foo/:bar", (req, res) => {
res.json({
foo : req.params.foo,
bar : req.params.bar
});
});
// Binds the express app to an Azure Function handler
module.exports = createHandler(app);
```
Make sure you are binding `req` and `res` in your `function.json`:
```json
{
"bindings": [{
"authLevel" : "anonymous",
"type" : "httpTrigger",
"direction" : "in",
"name" : "req",
"route" : "foo/{bar}/{id}"
}, {
"type" : "http",
"direction" : "out",
"name" : "res"
}]
}
```
To allow Express handles all HTTP routes itself you may set a glob star route in a single root `function.json`:
```json
{
"bindings": [{
"authLevel" : "anonymous",
"type" : "httpTrigger",
"direction" : "in",
"name" : "req",
"route" : "{*segments}"
}, {
"type" : "http",
"direction" : "out",
"name" : "res"
}]
}
```
Note that `segments` is not used and could be anything. See [Azure Function documentation](https://github.com/Azure/azure-webjobs-sdk-script/wiki/Http-Functions).
All examples [here](/examples/).
## Context
All native Azure Functions [context](https://docs.microsoft.com/en-us/azure/azure-functions/functions-reference-node#context-object) properties, except `done`, are exposed through `req.context`.
As en example, you can [log](https://docs.microsoft.com/en-us/azure/azure-functions/functions-reference-node#writing-trace-output-to-the-console) using:
```js
app.get("/api/hello-world", (req, res) => {
req.context.log({ hello: "world" });
...
});
```
## Runtime compatibility
Supported Node version are:
- Node 6.11.2 ([first node version supported by Azure Functions](https://github.com/Azure/azure-webjobs-sdk-script/issues/2036#issuecomment-336942961))
- Node 8 (LTS)
- Node 10
Azure Functions runtime v1 and v2 beta are both supported.
## License
[Apache 2.0](LICENSE) © Yves Merlicco