Express4 Tedious Middleware
Express4 middleware that enables you to create REST API using SQL Server and Tedious.
Contents
Setup
Initializing data access components
Create REST API
Setup
To install Tedious Express4 package, run the following command:
npm install express4-tedious --save
Initialize Middleware
In order to initialize data access middleware, you need to add sql
method to your
request when you initialize express app and routes:
var express = ;var tediousExpress = ; var app = ;app;
This call should be used before any other route definition. Connection object should look like:
{
"server" : "<<server name or ip>>",
"userName": "<<user name>>",
"password": "<<password>>",
"options": { "encrypt": true, "database": "<<database name>>" }
}
Use "encrypt": true
if database is hosted in Azure SQL.
Create REST API
Once you setup the middleware, you can easily create REST API using T-SQL queries:
/* GET product listing. */router;
In the sql
method you can specify T-SQL query that should be executed. Method
into
will stream results of the query into response object. []
will be sent to
the client if results are not returned by query. You can provide second patamater that
represents a custom string that should be returned if there is no response from database.
You can also create REST API that uses parameters:
/* GET product by id. */router;
You can create REST APIs that are invoked using POST, PUT, and DELETE methods, and execute
SQL query using exec
method (without results returned to the client):
/* PUT update product. */router;
Note: you need to provide
res
object to theexec
method, because this method will return status code to the client.
Handling errors
This middleware returns error 500
if any error happens with descirption of the error as plain text.
You can customize the function that handles the error and provide your own error handler:
/* PUT update product. */router;
Error handler is a function that gets exception and response output as parameters.