ASP.NET Core 1.0 MVC 6 Using WEB API And AngularJS

Syed Shanu
8y
45.1k
0
2

Article

aspnet

Introduction

In this article we will see in detail how to create ASP.NET Core 1.0 MVC 6 using WEB API and AngularJS .

You can also view our previous article.

Prerequisites

Visual Studio 2015: You can download it from here.
ASP.NET 5 /Core 1.0: download ASP.NET 5 RC from this link.

In this article we will see in detail how to:

Create our ASP.NET Core 1.0 Web Application.
How to change the Default Connection string to our SQL Server Connection String.
How to add Model and DbContext Class for using in WEB API
How to add Entity framework Service in Startup.cs file.
How to add our WEB API Controller.
How to add grunt package using NPM configuration file
How to configure Grunt File.
How to Run the Grunt file using Visual Studio Task Runner Explorer
How to create our AngularJS Module, Controller and Service file and get WEB API data for bind in MVC page.

Reference link

Using the code

Create a Database

We will be using our SQL Server database for our WEB API. First we create a database named StudentsDB and a table as StudentMaster. Here is the SQL script to create Database table and sample record insert query in our table.

USEMASTER
GO
-- 1) Check for the Database Exists .If the database is exist then drop and create new DB
IFEXISTS(SELECT [name] FROMsys.databasesWHERE [name] ='StudentsDB')
DROPDATABASEStudentsDB
GO
CREATEDATABASEStudentsDB
GO
USEStudentsDB
GO
-- 1) //////////// StudentMasters
IFEXISTS(SELECT [name] FROMsys.tablesWHERE [name] ='StudentMasters')
DROPTABLEStudentMasters
GO
CREATETABLE [dbo].[StudentMasters](
[StdID] INTIDENTITYPRIMARYKEY,
[StdName] [varchar](100)NOTNULL,
[Email] [varchar](100)NOTNULL,
[Phone] [varchar](20)NOTNULL,
[Address] [varchar](200)NOTNULL
)
-- insert sample data to Student Master table
INSERTINTO [StudentMasters]([StdName],[Email],[Phone],[Address])
VALUES ('Shanu','[email protected]','01030550007','Madurai,India')
INSERTINTO [StudentMasters]([StdName],[Email],[Phone],[Address])
VALUES ('Afraz','[email protected]','01030550006','Madurai,India')
INSERTINTO [StudentMasters]([StdName],[Email],[Phone],[Address])
VALUES ('Afreen','[email protected]','01030550005','Madurai,India')
select*from [StudentMasters]

Create our ASP.NET Core 1.0 Web Application.

After installing both Visual Studio 2015 and ASP.NET 5 RC.click Start, then Programs and select Visual Studio 2015 - Click Visual Studio 2015. Click New, then Project, select Web and select ASP.NET Web Application. Enter your Project Name and click OK.

new

Select Web Application under ASP.NET 5 Template and click ok.

Database Connection String:

Now we need to change the local connection string from ASP.Net 5 project with our SQL Server connection.

Note:

In ASP.NET 5 we need to use “appsettings.json” file instead of web.config. Yes in ASP.NET 5 there is no web.Config file for connection string we need use the “appsettings.json” .We can find the “appsettings.json” file from our Asp.NET 5 solution.

test

To change the default connection string with our SQL connection open the “appsettings.json” file .Yes this is a JSON file and this file looks like the below Image by default.

code

Now the default connectionstring will be something like this,

"ConnectionString": "Server=(localdb)\\mssqllocaldb;Database=aspnet5-MYASP.NET5DemoTest-afb3aac0-d181-4278-8436-cafeeb5a8dbf;Trusted_Connection=True;MultipleActiveResultSets=true"

Now we change this to our SQL Connection like below,

"ConnectionString": "Server=YourSQLSERVERNAME;Database=StudentsDB;user id=SQLID;password=SQLPWD;Trusted_Connection=True;MultipleActiveResultSets=true;"

Here you can change as per your SQL Connection and save the “appsettings.json” file. The updated JSON file will be looks like this.

code

Creating our Model

We can create a model by adding a new class file in our Model Folder.

test

Right click the Models folder and click add new Item .Select Class and enter your class name as “StudentMasters.cs”

add

Here our class will be look like the below image. Here we will add our model field property.

model

Add the header file usingSystem.ComponentModel.DataAnnotations; and add all our table field name as property in this model class like the below code.

using System;
usingSystem.Collections.Generic;
usingSystem.Linq;
usingSystem.Threading.Tasks;
usingSystem.ComponentModel.DataAnnotations;
namespace MYASP.NET5DemoTest.Models
{
publicclassStudentMasters
{
[Key]
publicintStdID
{
get;
set;
}
[Required]
[Display(Name = "Name")]
publicstringStdName
{
get;
set;
}
[Required]
[Display(Name = "Email")]
publicstring Email
{
get;
set;
}
[Required]
[Display(Name = "Phone")]
publicstring Phone
{
get;
set;
}
publicstring Address
{
get;
set;
}
}
}

Now we have created our Model, thenext step is to add DBContext for our model.

Creating DbContext

Now we need to create a DBContext for our Entity Framework. Same as with Model Class, add a new class to our Models folder.

Right click the Models folder and click add new Item .Select Class and enter your class name as “StudentMastersAppContext.cs”

add

Here our class will be look like the below image.

code

Now first we need to add the header file for Entity framework as usingMicrosoft.Data.Entity;

Next inherit the DbContextto our class and then create object for our DBContext like below code.

usingSystem.Collections.Generic;
usingSystem.Linq;
usingSystem.Threading.Tasks;
usingMicrosoft.Data.Entity;
namespace MYASP.NET5DemoTest.Models
{
publicclassStudentMastersAppContext: DbContext
{
publicDbSet < StudentMasters > Students
{
get;
set;
}
}
}

Now we can created our DB context and the next step is to add a Service for our Entity Framework.

Adding Entity Framework Service in Startup.cs

Next we need to add our Entity Framework service in Startup.cs . We can find the Startup.cs file from our solution explorer .

test

Open the Startup.csfile and we can see by default the ApplicationDBContext will be added in ConfigureServices method.

code

Now we can add one more DBContext for our StudentMastersAppContext like below code.

// Add Entity Framework
services.AddEntityFramework()
.AddSqlServer()
.AddDbContext < StudentMastersAppContext > (options =>
options.UseSqlServer(Configuration["Data:DefaultConnection:ConnectionString"]));
In ConfigureServices method we add like this code below.
publicvoidConfigureServices(IServiceCollection services)
{
// Add framework services.
services.AddEntityFramework()
.AddSqlServer()
.AddDbContext < ApplicationDbContext > (options =>
options.UseSqlServer(Configuration["Data:DefaultConnection:ConnectionString"]));
services.AddIdentity < ApplicationUser, IdentityRole > ()
.AddEntityFrameworkStores < ApplicationDbContext > ()
.AddDefaultTokenProviders();
services.AddMvc();
// Add Entity Framework
services.AddEntityFramework()
.AddSqlServer()
.AddDbContext < StudentMastersAppContext > (options =>
options.UseSqlServer(Configuration["Data:DefaultConnection:ConnectionString"]));
// Add application services.
services.AddTransient < IEmailSender, AuthMessageSender > ();
services.AddTransient < ISmsSender, AuthMessageSender > ();
}

Next step is to add WEBAPI Controller.

Creating our WEB API Controller

Right click the Controller folder and click add new Item .Select API Controller with Action, using Entity Framework and click Add.

scaffold

Now we need to select our newly created Model class and our Data Context Class.

Model Class: In Model Class select our Model Class which we created as “StudentMasters”.

Data Context Class: In Data Context select our DBContext class which we created as “StudentMastersAppContext”

Give our Controller name with API and click ADD.

Now we can see our WEB API Controller has been created,

code

To test it we can run our project and copy the get method api path here we can see our API path for get is api/StudentMasters/

Run the program and paste the above API path to test our output.

output

Create Scripts and Controller Folder:

Next we need to add a new folder in our project for AngularJs.
Create a new folder named “Scripts” .Right click our project and click add new Folder and name the folder as “Scripts”

test

Now we create one more folder for our AngularJs controller named as “Controllers”

test

Adding grunt package using NPM configuration file

Now we need to add a NPM Configuration File for adding a grunt package to run our Java scripts.
As we have created as a Web Application the NPM Configuration File will be located in our project.
By default we can’t view our NPM Configuration File. The NPM Configuration File will be in the name of “package.JSON”. TO view that from the Solution Explorer click on “Show All Files”

test

Now we can see NPM file as “package.JSON”

json

Dependencies Folder:

folder

In dependency folder we can see the entire installed NPM package. Here we can see by default grunt package has not been installed .Here we will see how to add the grunt package.

If this “package.JSON” is not available

Right click our Project and click Add New Item to add our NPM Configuration File. Select Client-Side and Select NPM Configuration File and click Add.

add

Now open the “package.JSON” file .Now first we need to change the name to our project Solution name and add our grunt package. We can see the code here below the image.

code

Here we have changed the name as our Solution name and also added the grunt package.

{
"name": "testforDemo",
"version": "0.0.0",
"devDependencies":
{
"gulp": "3.8.11",
"gulp-concat": "2.5.2",
"gulp-cssmin": "0.1.7",
"gulp-uglify": "1.2.0",
"rimraf": "2.2.8",
"grunt": "0.4.5",
"grunt-contrib-uglify": "0.9.1",
"grunt-contrib-watch": "0.6.1"
}
}

After adding the grunt file save the file .Now we can see in the Dependencies folder, Now save the package.json file and you should be able to see a grunt package under Dependencies/ npm Folder.

npm

Once we click on save “package.json: the “Dependencies” and “npm” folder will be as “Restoring”.

restore

Now right click the “Dependencies” folder and click Restore Packages. This will install all the packages to your npm folder.

Configure Grunt File.

Grunt is used to build all our client side resources like JavaScript for our project.

First step is to we need to add a Grunt file to our project. Right click our project and Select Client-Side and Select Grunt Configuration File and click Add.

add

Here we can see now we have added the Grunt file to our project. Next we need to edit this file to add loadplugins, configure plugins and define tasks,

code

Here in our Grunt file we have first loaded plugins which we have added in our npm. Using loadNpmTask here we load 'grunt-contrib-uglify' ,'grunt-contrib-watch'

npm

Next we configure the grunt, add the app.js file in our wwwrootfolder. All our Script files from Scripts folder result will be added in this app.js file.

The watch plugin will be used to check for any changes on JavaScript file and update it app.js with all new changes.

/*
This file in the main entry point for defining grunt tasks and using grunt plugins.
Click here to learn more. http://go.microsoft.com/fwlink/?LinkID=513275&clcid=0x409
*/
module.exports = function(grunt)
{
grunt.loadNpmTasks('grunt-contrib-uglify');
grunt.loadNpmTasks('grunt-contrib-watch');
grunt.initConfig
({
uglify:
{
my_target:
{
files:
{
'wwwroot/app.js': ['Scripts/app.js', 'Scripts/**/*.js']
}
}
},
watch:
{
scripts:
{
files: ['Scripts/**/*.js'],
tasks: ['uglify']
}
}
});
grunt.registerTask('default', ['uglify', 'watch']);
};

Save the file.

Run the Grunt file using Visual Studio Task Runner Explorer

Now we need to run the Grunt file using Visual Studio Task Runner.

To view the Task RunnerClick the menu View-> Other Windows,-> and click on Task Runner Explorer.

task

Now we can see our Task Runner Explorer.

Click on GruntFile.js and click on refresh button at top left.

grunt

Now we can see all the GruntFile has been added.

file

Right click the default under Alias Task and click Run.

run

Now our Grunt file has been successfully run in our project. When we add a script file we can see new app.js file will be created in our wwwroot folder.

folder

Create our AngularJS Module, Controller and Service

Creating AngularJS Module:

Now we will create a new AngularJs module under our Scripts folder.

Right click our Scripts folder and click add new Item and Select Client-Side and Select AngularJs Module and click Add.

add

Now we can see a default AngularJS Module code like below.

(function()
{
'use strict';
angular.module('app', [
// Angular modules
'ngRoute'
// Custom modules
// 3rd Party Modules
]);
})();

Change this with our Module Name and service name for calling WEB API and binding from Controller.

(function()
{
'use strict';
angular.module('studentapp', [
// Angular modules
'studentService'
// Custom modules
// 3rd Party Modules
]);
})();

Creating AngularJS Service:

Now we will create a new AngularJsServiceunder Controllers folder inside Scripts folder.

Right click our Controllers folder under Scripts folder and clicks add new Item ,Select Client-Side and Select AngularJsFactory and click Add.

add

Now we can see the default code will be look like this below.

(function()
{
'use strict';
angular
.module('app')
.factory('factory', factory);
factory.$inject = ['$http'];
function factory($http)
{
var service =
{
getData: getData
};
return service;
functiongetData() {}
}
})();

Change this code to create our service and get our API data.

Here we create our Service as StudentService and get the result from our WEB API method and bind to APIData.

(function()
{
'use strict';
varstudentService = angular.module('studentService', ['ngResource']);
studentService.factory('student', ['$resource',
function($resource)
{
alert("hi");
return $resource('/api/StudentMasters/', {}, {
APIData:
{
method: 'GET',
params: {},
isArray: true
}
});
alert("hi12");
}
]);
})();

Creating AngularJS Controller:

Now we will create a new AngularJsControllerunder Controllers folder inside Scripts folder.
Right click our Controllers folder under Scripts folder and clicks add new Item ,Select Client-Side and Select AngularJs Factory and click Add.

Now we can see the default code will be look like this below.

(function()
{
'use strict';
angular
.module('app')
.controller('controller', controller);
controller.$inject = ['$location'];
function controller($location)
{
/* jshintvalidthis:true */
varvm = this;
vm.title = 'controller';
activate();
function activate() {}
}
})();

Change this code to create our Controller and get our API data from AngularJsServicde and store to $scope.student for binding in our MVC view.

(function()
{
'use strict';
angular
.module('studentapp')
.controller('studentController', studentController);
studentController.$inject = ['$scope', 'student'];
functionstudentController($scope, student)
{
$scope.student = student.APIData();
}
})();

Note: Nowagain open the Tast Runner Explorer and select the default under Gruntfile.js .

Right click and run it. We can see as “1 file created”.

Now we can see app.js file will be created in our wwwroot.And also all our AngularJS Module,Service and Conroller script will be added for displaying our data.

code

Design MVC View page, Run and Output.

Here I have bind the AngularJs controller result to our detaul home index View.

home

I have changed the default index.cshtml page to below html deign to bind our AngularJS controller Student data to our view.

<htmlng-app="studentapp">
@{ ViewBag.Title = "ASP.NET5"; }
<head>
</head>
<bodyng-controller="studentController">
<tablewidth="99%" style="border-bottom:3pxsolid#3273d5;">
<tr>
<tdwidth="190">
<tablewidth="99%">
<tr>
<td>
Welcome Mr. {{'SHANU'}}
</td>
</tr>
</table>
</td>
<tdclass="style1" align="center">
<h3>Shanu - ASP.NET Core 1.0 MVC 6 with WEB API and AngularJS :)</h3>
</td>
</tr>
</table>
<tablestyle="width: 99%; background-color:#FFFFFF; border solid 2px #6D7B8D; padding 5px;width 99%;table-layout:fixed;" cellpadding="2" cellspacing="2">
<trstyle="height: 30px; background-color:#336699 ; color:#FFFFFF ;border: solid1px#659EC7;">
<tdwidth="40" align="center"><b>Student ID</b></td>
<tdwidth="100" align="center"><b>Student Name </b></td>
<tdwidth="120" align="center"><b>Email</b></td>
<tdwidth="120" align="center"><b>Phone</b></td>
<tdwidth="120" align="center"><b>Address</b></td>
</tr>
<tbodydata-ng-repeat="details in student">
<tr>
<tdalign="center" style="border: solid1px#659EC7; padding: 5px;table-layout:fixed;">
<spanstyle="color:#9F000F">
{{details.StdID}}
</span>
</td>
<tdalign="center" style="border: solid1px#659EC7; padding: 5px;table-layout:fixed;">
<spanstyle="color:#9F000F">
{{details.StdName}}
</span>
</td>
<tdvalign="top" style="border: solid1px#659EC7; padding: 5px;table-layout:fixed;">
<spanstyle="color:#9F000F">
{{details.Email}}
</span>
</td>
<tdvalign="top" style="border: solid1px#659EC7; padding: 5px;table-layout:fixed;">
<spanstyle="color:#9F000F">
{{details.Phone}}
</span>
</td>
<tdvalign="top" style="border: solid1px#659EC7; padding: 5px;table-layout:fixed;">
<spanstyle="color:#9F000F">
{{details.Address}}
</span>
</td>
</tr>
</tbody>
</table>
</body>
</html>
<scriptsrc="//ajax.googleapis.com/ajax/libs/angularjs/1.4.8/angular.js">
</script>
<scriptsrc="//ajax.googleapis.com/ajax/libs/angularjs/1.4.8/angular-resource.js">
</script>
<scriptsrc="~/app.js">
</script>

Run the Program:

Here we can see all the data from WEB API has been bind to our MVC View using AngularJS.

output