This project contains an example implementation of NodeJS REST API with CRUD operations on a simple Todo table. You can learn how to build REST API on the existing database schema using NodeJS, Express4, and new JSON functionalities that are available in SQL Server 2016 (or higher) and Azure SQL Database.

About this sample
Before you begin
Run this sample
Sample details
Disclaimers
Related links

About this sample

Applies to: SQL Server 2016 (or higher), Azure SQL Database
Key features: JSON Functions in SQL Server 2016/Azure SQL Database - FOR JSON and OPENJSON
Programming Language: JavaScript (NodeJS)
Authors: Jovan Popovic

Before you begin

To run this sample, you need the following prerequisites.

Software prerequisites:

SQL Server 2016 (or higher) or an Azure SQL Database
Node.js runtime.

Azure prerequisites:

Permission to create an Azure SQL Database

Run this sample

Navigate to the folder where you have downloaded sample and run npm install in command window.
From SQL Server Management Studio or SQL Server Data Tools connect to your SQL Server 2016 or Azure SQL database and execute setup.sql script that will create and populate Todo table in the database.
Locate db.js file in the project, change database connection info in createConnection() method to reference your database. the following tokens should be replaced:
SERVERNAME - name of the database server.
DATABASE - Name of database where Todo table is stored.
USERNAME - SQL Server login that can access table data and execute stored procedures.
PASSWORD - Password associated to SQL Server login.

    var config = {
        server  : "SERVER.database.windows.net",
        userName: "USER",
        password: "PASSWORD",
        // If you're on Azure, you will need this:
        options: { encrypt: true, database: 'DATABASE' }
    };

Run sample app from the command line using node app.js
Open http://localhost:3000/todo Url to get list of all Todo items from a table,
Open http://localhost:3000/todo/1 Url to get details about a single Todo item with id 1,
Send POST, PUT, or DELETE Http requests to update content of Todo table.

Sample details

This sample application shows how to create simple REST API service that performs CRUD operations on a simple Todo table. NodeJS REST API is used to implement REST Service in the example.

app.js file that contains startup code.
db.js file that contains functions that wrap Tedious library
todo.js file that contains action that will be called on GET, POST, PUT, and DELETE Http requests.

Service uses Tedious library for data access and built-in JSON functionalities that are available in SQL Server 2016 and Azure SQL Database.

Disclaimers

The code included in this sample is not intended demonstrate some general guidance and architectural patterns for web development. It contains minimal code required to create REST API. You can easily modify this code to fit the architecture of your application.

For more information, see this MSDN documentation.

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

License

These samples and templates are all licensed under the MIT license. See the license.txt file in the root.

Questions

Email questions to: [sqlserversamples@microsoft.com](mailto: sqlserversamples@microsoft.com).

README.md

NodeJS Express4 REST API that uses SQL/JSON functionalities

Contents