Unit Testing Web API Using Swagger

Unit Testing Web API Using Swagger

 Introduction

In  this post we will use ASP.NET Web API to create a RESTful service and use a NuGet package to create Swagger(Open API) specification.  

Background

What is ASP.NET Web API?

ASP.NET Web API is a framework that makes it easy to build HTTP services that reach a broad range of clients, including browsers and mobile devices. ASP.NET Web API is an ideal platform for building RESTful applications on the .NET Framework.

What is Swagger? 

Swagger is a simple yet powerful representation of your RESTful API. With the largest ecosystem of API tooling on the planet, thousands of developers are supporting Swagger in almost every modern programming language and deployment environment.

Advantages of Swagger

·       It's comprehensible for developers and non-developers. Product managers, partners, and even potential clients can have input into the design of your API, because they can see it clearly mapped out in this friendly UI.

·       It's human readable and machine readable. This means that not only can this be shared with your team internally, but the same documentation can be used to automate API-dependent processes.

·       It's easily adjustable. This makes it great for testing and debugging API problems.

 Using the code

Step 1 Adding Swagger to Web API Project

To add Swagger to Web API, we just need to install an open source project called Swashbuckle via NuGet.

Step 2 .  Install NuGet Packages

Install "Swashbuckle.AspNetCore" NuGet package in the solution. 

After Installation, you can see the swaggerconfig.cs under app_start folder in your project.

Step 3 View the Swaggerconfig.cs 

Step 4 Configure Swagger

At minimum, we need this line to enable Swagger and Swagger UI. 

Step 5 Now, run your API application and Just type swagger after service. You will get the UI of swagger with list API including whatever we wrote in services.

http://localhost:59400/swagger/ui/index#/Values

Unit Testing with API

 Click on Try it out button It will send a response for Get and Post Method.

Happy Programming!!

Don’t forget to leave your feedback and comments below!

If you have any query mail me to Sujeet.bhujbal@gmail.com     

Regards

Sujeet Bhujbal

--------------------------------------------------------------------------------

 Blog: www.sujeetbhujbal.com

Personal Website :-http://sujitbhujbal.wordpress.com/

Facebook :-http://www.facebook.com/bhujbal.sujit

CodeProject:-http://www.codeproject.com/Members/Sujit-Bhujbal

DotNetHeaven:-http://www.dotnetheaven.com/Authors/sujit9923/sujit-bhujbal.aspx

CsharpCorner:-http://www.c-sharpcorner.com/Authors/sujit9923/sujit-bhujbal.aspx

Linkedin :-http://in.linkedin.com/in/sujitbhujbal

Stack-Exchange: http://stackexchange.com/users/469811/sujit-bhujbal

Twitter :-http://twitter.com/SujeetBhujbal

 JavaTalks :-http://www.javatalks.com/Blogger/sujit9923/

------------------------------------------------------------------------------

Web API Token Based Authentication

 Web API Token Based Authentication

Introduction

In this article, I will tell you how to create token based authentication in WEB API using OWIN easily.

Background

Authentication and authorization is very much important in every project. There are so many articles already written for authentication in web apin. Therefore, in this article I will tell you how to create token based authentication in Web Api using OWIN within 10 minutes. 

First I will tell you 

1. What is Token Based Authentication : 

In Token based authentication users allows to enter username and password to obtain a token which allows them to fetch a specific resource without using their username and password. Once their token has been retrieved, the user can offer the token – which offers access to a specific resource for a time period

2. OWIN (Open Web Interface for .NET) :

OWIN defines a standard interface between .NET web servers and web applications. You will get more information from http://owin.org/

Advantages of OWIN

1. Scalable: The token itself holds all encrypted user info, so adding more servers to your web farm is an easy task.

2. Mobile Friendly: Comparing with cookies, storing token in native mobile platforms or browsers could be a standard way.

3. Decoupled: Any server providing token Auth service could be an alternative option.You can plug any middlewares (and as many as you want) between the webserver and your application.

4. Safer: CSRF Attack Prevent.

5. Performance: Decoding token to get use info is usually faster than querying DB.

Disadvantages of OWIN

Need additional code to store and send token.

Using the code

1. Create WEB API Application  : 

First we will create empty WEB API application using visual studio 2017

2. Package Installation :

 We will add below package to our solution

Install-Package Microsoft.AspNet.WebApi.Owin -Version 5.2.2

Install-Package Microsoft.Owin.Host.SystemWeb -Version 2.1.0

Install-Package Microsoft.AspNet.Identity.Owin -Version 2.0.1

Install-Package Microsoft.AspNet.Identity.EntityFramework -Version 2.0.1

Install-Package Microsoft.Owin.Security.OAuth -Version 2.1.0

Install-Package Microsoft.Owin.Cors -Version 2.1.0

3. Create below cs files in your project

1.Add below code in WebApiConfig

Add caption

2. Add below token based configuration in Startup.cs

3 Create new class SimpleAuthorizationServerProvider which will inherit OAuthAuthorizationServerProvider class which has two methods ValidateClientAuthetication and GrantResourceOwnerCredential

4. Add new Web Api controller. Give name as TokenTestController

4.Testing Token based authentication using POSTMAN

1. We will access token using token method

2. Then we will try to access /api/TokenTest/Authorize method directly without token. It will respond 401 as expected.

3. We will again send above request  along with the token from above #1 and we will get respond 200 as expected. As we have implemented token based authentication

Happy Programming!!

Don’t forget to leave your feedback and comments below!

If you have any query mail me to Sujeet.bhujbal@gmail.com     

Regards

Sujeet Bhujbal

--------------------------------------------------------------------------------

 Blog: www.sujeetbhujbal.com

Personal Website :-http://sujitbhujbal.wordpress.com/

Facebook :-http://www.facebook.com/bhujbal.sujit

CodeProject:-http://www.codeproject.com/Members/Sujit-Bhujbal

DotNetHeaven:-http://www.dotnetheaven.com/Authors/sujit9923/sujit-bhujbal.aspx

CsharpCorner:-http://www.c-sharpcorner.com/Authors/sujit9923/sujit-bhujbal.aspx

Linkedin :-http://in.linkedin.com/in/sujitbhujbal

Stack-Exchange: http://stackexchange.com/users/469811/sujit-bhujbal

Twitter :-http://twitter.com/SujeetBhujbal

 JavaTalks :-http://www.javatalks.com/Blogger/sujit9923/

--------------------------------------------------------------------------------

Asp.Net Core Duplicate 'Content' items were included. The .NET SDK includes 'Content' items from your project directory by default

Hello Friends

I got one error message in asp.net core while upgrading to Visual Studio 2017 version 15.3.1

Duplicate 'Content' items were included. The .NET SDK includes 'Content' items from your project directory by default. You can either remove these items from your project file, or set the 'EnableDefaultContentItems' property to 'false' if you want to explicitly include them in your project file. 

So Solution for this error message is

1. Click 'Show All Files' in Solution Explorer
2. Right click over 'wwwroot' select 'Exclude From Project'
3. Right click over 'wwwroot' select 'Include in Project'

Thanks

Sujeet 

 Happy Programming!!

Don’t forget to leave your feedback and comments below!

If you have any query mail me to Sujeet.bhujbal@gmail.com     

Regards

Sujeet Bhujbal

--------------------------------------------------------------------------------

 Blog: www.sujeetbhujbal.com

Personal Website :-http://sujitbhujbal.wordpress.com/

Facebook :-http://www.facebook.com/bhujbal.sujit

CodeProject:-http://www.codeproject.com/Members/Sujit-Bhujbal

DotNetHeaven:-http://www.dotnetheaven.com/Authors/sujit9923/sujit-bhujbal.aspx

CsharpCorner:-http://www.c-sharpcorner.com/Authors/sujit9923/sujit-bhujbal.aspx

Linkedin :-http://in.linkedin.com/in/sujitbhujbal

Stack-Exchange: http://stackexchange.com/users/469811/sujit-bhujbal

Twitter :-http://twitter.com/SujeetBhujbal

 JavaTalks :-http://www.javatalks.com/Blogger/sujit9923/

-------------------------------------------------------------------------------

What is ASP.NET Core

What is ASP.NET Core

ASP.NET Core is the latest Web application development framework from Microsoft. It is a redesign of the old ASP.NET framework and has already popular. ASP.NET Core is Open Source framework that you can use to build Web and Cloud applications. Most importantly, ASP.NET Core is available on Windows, Linux and Mac platforms.

Microsoft has made important changes with ASP.NET Core. Now, it is open source and available on GitHub. On GitHub, you can find everything about ASP.NET code and download it if you need

In Visual Studio you will see 2 new project types

New AppSetting.Json instead of web.config

ASP.NET Core has a client side package manager which is inbuilt with ASP.NET 5 project and it is bower. It is a package manager for JavaScript, jQuery etc

·         In Old .Net applications when we make build for application all dlls goes into the bin directory, which is available inside the project. Now Bin directory has been placed inside the Artifact folder, which is new with ASP.NET 5.

·         Dependency Injection is supported by ASP.NET inbuilt. It supports DI by default. ASP.NET includes some built in container which supports constructor injection by default.

wwwroot folder will contain all the static content of the application in ASP.NET Core like js files, css files, images as well.

ASP.NET Core has a client side package manager which is inbuilt with ASP.NET 5 project and it is bower. It is a package manager for JavaScript, jQuery etc

No VB.Net support as of now. It is to be added in future update.

Please check below microsoft article before choosing framework

https://docs.microsoft.com/en-us/dotnet/standard/choosing-core-framework-server

Some Cons

·         Not all libraries are ready for core,

·         New means all api’s aren’t tested by the age..coz its new.

·         All stuff you do are new even to other people, so if you find a problem, you probably need to solve/figure it out on your won, because everyone is still new to it..

 Happy Programming!!

Don’t forget to leave your feedback and comments below!

If you have any query mail me to Sujeet.bhujbal@gmail.com     

Regards

Sujeet Bhujbal

--------------------------------------------------------------------------------

 Blog: www.sujeetbhujbal.com

Personal Website :-http://sujitbhujbal.wordpress.com/

Facebook :-http://www.facebook.com/bhujbal.sujit

CodeProject:-http://www.codeproject.com/Members/Sujit-Bhujbal

DotNetHeaven:-http://www.dotnetheaven.com/Authors/sujit9923/sujit-bhujbal.aspx

CsharpCorner:-http://www.c-sharpcorner.com/Authors/sujit9923/sujit-bhujbal.aspx

Linkedin :-http://in.linkedin.com/in/sujitbhujbal

Stack-Exchange: http://stackexchange.com/users/469811/sujit-bhujbal

Twitter :-http://twitter.com/SujeetBhujbal

 JavaTalks :-http://www.javatalks.com/Blogger/sujit9923/

--------------------------------------------------------------------------------