Skip to content

Commit 0e46c20

Browse files
committed
Minor fixes in readme.md
Added minor corrections in readme.md files
1 parent 5831dcc commit 0e46c20

File tree

4 files changed

+32
-15
lines changed

4 files changed

+32
-15
lines changed

samples/features/json/todo-app/dotnet-rest-api/README.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# ASP.NET Core REST Web API that uses SQL/JSON functionalites
1+
# ASP.NET Core REST Web API that uses SQL/JSON functionalities
22

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

@@ -61,7 +61,7 @@ Service uses built-in JSON functionalities that are available in SQL Server 2016
6161
<a name=disclaimers></a>
6262

6363
## Disclaimers
64-
The code included in this sample is not intended demonstrate some general guidances and arhitectural patterns for web development. It contains minimal code required to create REST API, and it does not use some patterns such as Repository. Sample uses built-in ASP.NET Core Dependency Injection mechanism; however, this is not prerequisite.
64+
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, and it does not use some patterns such as Repository. Sample uses built-in ASP.NET Core Dependency Injection mechanism; however, this is not prerequisite.
6565
You can easily modify this code to fit the architecture of your application.
6666

6767
<a name=related-links></a>
@@ -70,8 +70,11 @@ You can easily modify this code to fit the architecture of your application.
7070

7171
For more information, see this [article](http://www.codeproject.com/Articles/1106622/Building-Web-API-REST-services-on-Azure-SQL-Databa).
7272

73+
## Code of Conduct
74+
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
75+
7376
## License
7477
These samples and templates are all licensed under the MIT license. See the license.txt file in the root.
7578

7679
## Questions
77-
Email questions to: sqlserversamples@microsoft.com.
80+
Email questions to: [sqlserversamples@microsoft.com](mailto: sqlserversamples@microsoft.com).

samples/features/json/todo-app/nodejs-express4-rest-api/README.md

+21-12
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# NodeJS Express4 REST API that uses SQL/JSON functionalites
1+
# NodeJS Express4 REST API that uses SQL/JSON functionalities
22

3-
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 new JSON functionalities that are available in SQL Server 2016 (or higher) and Azure SQL Database.
3+
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.
44

55
### Contents
66

@@ -39,31 +39,40 @@ To run this sample, you need the following prerequisites.
3939

4040
## Run this sample
4141

42-
1. Navigate to the folder where you have downloaded sample and run **npm install** in command window. This command will install necessary npm packages defined in project.json.
42+
1. Navigate to the folder where you have downloaded sample and run **npm install** in command window, or run setup.bat if you are on Windows operating system. This command will install necessary npm packages defined in project.json.
4343

44-
2. 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.
44+
2. 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.
4545

4646
3. From Visual Studio, open the **TodoApp.xproj** file from the root directory,
4747

48-
4. Locate db.js file in the project, change database connection info in createConnection() method to reference your database, and build solution using Ctrl+Shift+B, right-click on project + Build, or Build/Build Solution from menu.
48+
4. Locate db.js file in the project, change database connection info in createConnection() method to reference your database. the following tokens should be replaced:
49+
4.1. SERVERNAME - name of the database server.
50+
4.2. DATABASE - Name of database where Todo table is stored.
51+
4.3. USERNAME - SQL Server login that can access table data and execute stored procedures.
52+
4.4. PASSWORD - Password associated to SQL Server login.
4953

50-
5. Run sample app using F5 or Ctrl+F5,
51-
4.1. Open /api/Todo Url to get all Todo items as a JSON array,
52-
4.2. Open /api/Todo/1 Url to get details about a single Todo item with id 1,
53-
4.3. Send POST, PUT, PATCH, or DELETE Http requests to update content of Todo table.
54+
5. Build project using Ctrl+Shift+B, right-click on project + Build, or Build/Build Solution from menu.
55+
56+
6. Run sample app using F5 or Ctrl+F5. /todo Url will be opened with a list of all Todo items as a JSON array,
57+
6.1. Open /api/Todo/1 Url to get details about a single Todo item with id 1,
58+
6.2. Send POST, PUT, or DELETE Http requests to update content of Todo table.
5459

5560
<a name=sample-details></a>
5661

5762
## Sample details
5863

5964
This sample application shows how to create simple REST API service that performs CRUD operations on a simple Todo table.
6065
NodeJS REST API is used to implement REST Service in the example.
61-
Service uses built-in JSON functionalities that are available in SQL Server 2016 and Azure SQL Database.
66+
1. app.js file that contains startup code.
67+
2. db.js file that contains functions that wrap Tedious library
68+
3. todo.js file that contains action that will be called on GET, POST, PUT, and DELETE Http requests.
69+
70+
Service uses Tedious library for data access and built-in JSON functionalities that are available in SQL Server 2016 and Azure SQL Database.
6271

6372
<a name=disclaimers></a>
6473

6574
## Disclaimers
66-
The code included in this sample is not intended demonstrate some general guidances and arhitectural patterns for web development.
75+
The code included in this sample is not intended demonstrate some general guidance and architectural patterns for web development.
6776
It contains minimal code required to create REST API.
6877
You can easily modify this code to fit the architecture of your application.
6978

@@ -80,4 +89,4 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope
8089
These samples and templates are all licensed under the MIT license. See the license.txt file in the root.
8190

8291
## Questions
83-
Email questions to: sqlserversamples@microsoft.com.
92+
Email questions to: [sqlserversamples@microsoft.com](mailto: sqlserversamples@microsoft.com).
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
npm install

samples/features/readme.md

+4
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,7 @@ Master Data Services (MDS) is the SQL Server solution for master data management
1111
[R Services](features/r-services)
1212

1313
SQL Server R Services brings R processing close to the data, allowing more scalable and more efficient predictive analytics.
14+
15+
[JSON Support](features/json)
16+
17+
Built-in JSON functions enable you to easily parse and query JSON data stored in database, transform relational data to JSON text, and vice versa.

0 commit comments

Comments
 (0)