Scribd
Upload
117 views

MVC - REST Web API SQL Server Connection Using Entity Framework Database First Approach

The document discusses connecting a REST Web API to a SQL Server database using Entity Framework and the database first approach in ASP.NET MVC. It demonstrates creating a RESTful GET method that loads data from SQL Server using the DbContext and returns an HTTP response. The steps shown include creating a new Web API project, adding an Entity Data Model to connect to the database, creating a controller with a GET method that calls a stored procedure using the DbContext, and testing the API using a REST client. The goal is to learn how to create a REST API connection to SQL Server and load data from the database to return in responses.

Uploaded by

Elsadig Osman
Copyright
© © All Rights Reserved
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
117 views

MVC - REST Web API SQL Server Connection Using Entity Framework Database First Approach

The document discusses connecting a REST Web API to a SQL Server database using Entity Framework and the database first approach in ASP.NET MVC. It demonstrates creating a RESTful GET method that loads data from SQL Server using the DbContext and returns an HTTP response. The steps shown include creating a new Web API project, adding an Entity Data Model to connect to the database, creating a controller with a GET method that calls a stored procedure using the DbContext, and testing the API using a REST client. The goal is to learn how to create a REST API connection to SQL Server and load data from the database to return in responses.

Uploaded by

Elsadig Osman
Copyright
© © All Rights Reserved
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
You are on page 1/ 3

ASP.

NET MVC - REST Web API SQL Server


Connection Using Entity Framework Database
First Approach
One of the key advantages of using REST Web API as a mode of data exchange
between client-server machines is that it can connect any type to a data source, and
client machines do not need to bother about it. Depending on the business
requirements, any sort of database; e.g. SQL server, MySQL, CSV files, Excel file etc.,
can be connected with the underlying development platform to exchange data with
the client machines.
 
Today, I shall be demonstrating the creation of a REST Web API connection with SQL
server Entity Framework Database First approach using ASP.NET REST Web API
platform
Prerequisites
 
Following are some prerequisites before you proceed any further in this tutorial.

1. Knowledge of REST Web API.


2. Knowledge of ASP.NET MVC5.
3. Knowledge of C# Programming.

The example code is being developed in Microsoft Visual Studio 2019 Professional. I
have taken the data sample from AdventureWorks for SQL server 2014.
 
Let's begin now.
 
Step 1
 
Create new Web API project and name it "RESTWebApiGetMethod".  
 
Step 2
 
Although you can create your entity framework model inside any hierarchy of the
project,  I prefer "Models" folder, to keep code cleaner. So, right click on your
"Models" folder and then click "Add->ADO.NET Entity Data Model" as shown below
i.e.
Step 3
 
Now, from "Entity Data Model Wizard" choose "EF Designer from database", since I
am creating entity framework database first approach model. Then click "Next" as
shown below i.e.
Step 4
 
On the "Choose Your Data Connection" window, click "New Connection" button and
create your SQL server connection as shown below i.e.:
Step 5
 
Now, on "Choose Your Data Connection" window, click "Yes, include sensitive data
in connection string" option and click "Next" as shown below i.e.:
Step 6
 
Now, on "Choose Your Database Objects and Settings" window, choose your target
database objects. In my case, I have select only the store procedures. Then click
"Finish" as shown below i.e.:
Step 7
 
Create "Controllers\WebApiController.cs" file.
 
Step 8
 
Create a global parameter in "Controllers\WebApiController.cs" file to access
DbContext of your SQL server connection and name it "databaseManager".
 
Step 9
 
Now, create "Get" method without parameter inside
"Controllers\WebApiController.cs" file and replace the following code in it i.e.:

1. ...  
2.         public HttpResponseMessage Get()  
3.         {  
4.             // Initialization  
5.             HttpResponseMessage response = null;  
6.             DataTable responseObj = new DataTable();  
7.             string json = string.Empty;  
8. ...  
9.             // Loading Data from SQL server.  
10.             var data = this.databaseManager.GetProductByPric
eGreaterThan1000().ToList()  
11. ...  
12.             // Process data  
13. ...  
14.             // Create HTTP Response.  
15. ...  
16.             // Info.  
17.             return response;  
18.         }  
19. ...  

In the above code, I am simply using my entity framework DbContext global


variable to access a strore procedure from my SQL server database.
 
Step 10
 
If you execute the attached solution in REST Web API client, in my case I am using
Firefox plugin i.e. "RESTED" and you will be able to see  the following response i.e.:
Conclusion
 

In this article, you learned to create REST Web API connection with SQL server Entity
Framework Database First approach using ASP.NET REST Web API platform. You learned
about creating GET type method with input request parameter. You learned to load data
from SQL server using entity framework database first approach and finally, you  learned to
test REST Web API using any REST client to see your REST Web API in action before
consumption.

https://www.c-sharpcorner.com/article/asp-net-mvc-rest-web-api-sql-server-connection-using-entity-
framework-database/?
fbclid=IwAR1e6EnZMDOuppoEHH6MYEOt6IMvo0PeC_rAsgeJMg2Hz0afBV_cGTLevwc

You might also like