Post
Ask Question

CRUD Operations With Web API Using FluentNHibernate and Repository Pattern

Introduction

In this step-by-step article we will discuss all about Create, Read, Update, Delete (CRUD) operations with the Web API using the Repository pattern and using the most popular ORM, FluentNHibernate. In this article we will not go into depth about how to consume WEB APIs.

I recommend reading following article to learn more if you want to use the Web API from a third-party as a client:

Why Web API

While preparing this whitepaper I asked myself the question "Why Web API?". In simple and shorter words there are numerous things why we are doing with the Web API and not with WebServices, WCF or REST WCF.

I categorized these as follows:

  • Features
  • Functionalities
  • Resources
  • Behavioral

Although we will not dig deely into the preceding, that is beyond our main topic, but I would like to recommend reading the following to understand these terms better:

Pre-requisites

To work with the source code and taste the flavor of ASP.NET WEB API, you should have:

  • Basic knowledge of ASP.NET MVC
  • Basic knowledge of ReST services
  • Basic knowledge of FluentNHibernate
  • Required Visual Studio 2012 or later with ASP.NET WEB API support

Step 1: Create ASP.NET WEB API Project

To start we are using the following simple ASP.Net project:

  • Start Visual Studio and select "File" -> "New" -> "Project..." (or enter Ctrl + Shift + N).



  • From the available dialog choose Web Templates -> ASP.Net MVC 4 Web Application
  • I named it "CRUDWithWebAPI", you can choose your favorite one.
  • Select Empty Web API using Razor View Engine.


    (P.S.: Alternatively you can Select Create a unit test project, we are not discussing this topic here.)

Step 2: Visiting Folder Structure

After the preceding step, we will see that our project template is ready and the following is the default folder structure provided by the template:

  • App_Data
  • App_Start: contain config classes required to initiate the app (eg. route collection and so on.)
  • Controllers: controller of web API
  • Models: Contain model/classes
  • Scripts: all scripts and CSS
  • Views



    (P.S.: We are not going into more of an explanation of each and every folder shown above, since it is beyond the scope of this article.)

Step 3: Installing FluentNHibernate Support

To install FluentNHibernate support to the project:

  • Open "Package Manager Console" using View-> Other Windows
  • Now type "Install-Package FluentNHibenrate" and hit Enter

Wait until FluentNHibernate is installed.

Step 4: Working on Models, Mappings and Repository Pattern

In this step, we will create the Model and its mapping and will add a repository.

Adding Models and their Mappings

  • To add the model, right-click on the Models folder from the Solution Explorer and choose the class name "ServerData".
    1. public class ServerData  
    2. {  
    3.    public virtual int Id { get; set; }  
    4.    public virtual DateTime InitialDate { get; set; }  
    5.    public virtual DateTime EndDate { get; set; }  
    6.    public virtual int OrderNumber { get; set; }  
    7.    public virtual bool IsDirty { get; set; }  
    8.    public virtual string IP { get; set; }  
    9.    public virtual int Type { get; set; }  
    10.    public virtual int RecordIdentifier { get; set; }  
    11. }  

Adding Model Mappings

  • To add its mapping class, right-click on the Models folder from the Solution Explorer and choose the class name "ServerDataMap".
    1. public class ServerDataMap : ClassMap<ServerData>  
    2. {  
    3.     public ServerDataMap()  
    4.     {  
    5.         Table("ServerData");  
    6.   
    7.         Id(x => x.Id, "Id").GeneratedBy.Identity().UnsavedValue(0);  
    8.   
    9.         Map(x => x.InitialDate);  
    10.         Map(x => x.EndDate);  
    11.         Map(x => x.OrderNumber);  
    12.         Map(x => x.IsDirty);  
    13.         Map(x => x.IP).Length(11);  
    14.         Map(x => x.Type).Length(1);  
    15.         Map(x => x.RecordIdentifier);  
    16.   
    17.     }  
    18. }  
  • Do not forget to add the following namespace:
    1. using FluentNHibernate.Mapping;  

Adding Fluent NHibernate support to the project

  • Add a new folder and name it "Helper"
  • Add a new class beneath the "Helper" folder and name it "NHibernateHelper"

In this class we need to configure NHibernate and build all sessionfactory, so our application will interact with the database:

  1. private static void CreateSessionFactory()  
  2. {  
  3.     _sessionFactory = Fluently.Configure()  
  4.         .Database(MsSqlConfiguration.MsSql2008.ConnectionString(connectionString).ShowSql)  
  5.     .Mappings(m => m.FluentMappings.AddFromAssemblyOf<ServerData>())  
  6.        .ExposeConfiguration(cfg => new SchemaExport(cfg).Create(false, false))  
  7.     .BuildSessionFactory();  
  8. }  

We are not going to discuss all that stuff in details since they are beyond the scope of this article.

  • Create a new folder beneath "Models" and name it "Persistance"
  • Add one Interface "IServerDataRepository" under "Persistance"
    1. public interface IServerDataRepository  
    2. {  
    3.    ServerData Get(int id);  
    4.    IEnumerable<ServerData> GetAll();  
    5.    ServerData Add(ServerData serverData);  
    6.    void Delete(int id);  
    7.    bool Update(ServerData serverData);  
    8. }  
  • Add one class "ServerDataRepository" under "Persistance" and implement "IServerDataRepository"
    1. public class ServerDataRepository : IServerDataRepository  
    2. {  
    3.     //method implementation goes here     
    4. }  

We arw now ready  to start playing with our Repository.

P.S.: refer to the msdn for more details of the Repository Pattern.

Step 5: Add WEB API Controller

In this step, we will add an API controller and will add all the necessary resources.

  • Right-click on the folder "Controllers" and add a new controller; name it "ServerDataController" (select an empty controller)
  • It will look like:
    1. public class ServerDataController : ApiController  
    2. {  
    3. }  
  • Add the following line of code (it will initiate our repository).

    static readonly IServerDataRepository serverDataRepository = new ServerDataRepository();

P.S.: Please note that in this article/demo we are not going to implement any DI pattern or Inversion of Control (IOC) framework.

We are all set to go now:

  1. public IEnumerable<ServerData> GetServerData()  
  2. {  
  3.     return serverDataRepository.GetAll();  
  4. }  

In the preceding defined method, why we addd the "Get" suffix. It is a good practice to add "Get" with your method name, by convention it maps to a GET request.

This method has no parameter, so you can say this maps to a URI without an "id" parameter.

  • Add the following method to get the ServerData by id. This is an optional parameter as defined in our route and the ASP.Net Web API framework automatically converts its type to int.
  • It will throw a "HttpResponseException" expception if it is not valid (in the following method we converted the exception to a 404 NOT Found exception).
    1. public ServerData GetServerDataById(int id)  
    2. {  
    3.     var serverData = serverDataRepository.Get(id);  
    4.   
    5.     if (serverData == null)  
    6.         throw new HttpResponseException(HttpStatusCode.NotFound);  
    7.   
    8.     return serverData;  
    9. }  
  • The following method gets the ServerData by its type:
    1. public IEnumerable<ServerData> GetServerDataByType(int type)  
    2. {  
    3.    return serverDataRepository.GetAll().Where(d => d.Type == type);  
    4. }  
  • To invoke the preceding method we need to define new routes in "WebApiConfig.cs" as follows:
    1. config.Routes.MapHttpRoute
    2. (  
    3.    name: "ProductByType",  
    4.    routeTemplate: "api/{controller}/type/{type}"  
    5. );  
  • Similarly for:
    1. public IEnumerable<ServerData> GetServerDataByIP(string ip)  
    2. {  
    3.   return serverDataRepository.GetAll().Where(d => d.IP.ToLower() == ip.ToLower());  
    4.  }  
    5. config.Routes.MapHttpRoute
    6. (  
    7.     name: "ProductByIP",  
    8.     routeTemplate: "api/{controller}/ip/{ip}"  
    9. );  
  • Here we will delete serverdata using this method:
    1. public void DeletServerData(int id)  
    2. {  
    3.     var serverData = serverDataRepository.Get(id);  
    4.   
    5.     if (serverData == null)  
    6.         throw new HttpResponseException(HttpStatusCode.NotFound);  
    7.     serverDataRepository.Delete(id);  
    8. } 
  • Let's add a new method to our controller to add a new record of ServerData:
    1. public ServerData PostServerData(ServerData serverData)  
    2. {  
    3.     return serverDataRepository.Add(serverData);  
    4. }  

Will the preceding method work? Of course, it works but it's not an ideal or say it's not quite complete, why?

  • In the preceding suffix is "Post" that sounds it sends Http POST request
  • Also its noticeable parameter is of type "ServerData".
  • Complex type parameters are deserialized from the requested body when we use the Web API. We can also say we expect serialized input from the client, like either in XML or JSON.

In the preceding method, we missed the following from the HTTP response:

  • Response code: by default it is 200 (Ok) but as per HTTP1.1 protocol, the server should reply 201 (created), whereas POST request resuts in the creation of a resource.
  • Location: the server should include the URI of the new resource in the location header of the response, whenever it creates a resource.
  • So, we can implement this as defined in the following methods:
    1. public HttpResponseMessage PostServerData(ServerData serverData)  
    2. {  
    3.     serverData = serverDataRepository.Add(serverData);  
    4.   
    5.     var response = Request.CreateResponse<ServerData>          (HttpStatusCode.Created, serverData);  
    6.   
    7.     var uri = Url.Link("DefaultApi", new { id = serverData.Id });  
    8.     response.Headers.Location = new Uri(uri);  
    9.   
    10.     return response;  
    11.   
    12. }  
  • Finally, we need to add an update method, it's straight forward:
    1. public void PutServerData(int id, ServerData serverData)  
    2. {  
    3.     serverData.Id = id;  
    4.   
    5.     if (!serverDataRepository.Update(serverData))  
    6.         throw new HttpResponseException(HttpStatusCode.NotFound);  
    7. }  

From the preceding, we can understand that the WEB API matches this method to a PUT request. The preceding has two parameter ids and serverdata. So, it is taken from the URI path and the serverdata is deserialized from the request body.

P.S.: By default the Web API framework takes simple parameter types from the route and complex types from the request body.

Step 6: Set default result output type

We need the result in JSON by default, let's add the following line either in the Global.asx.cs file or in the file where you are registering routes.

  1. //return JSON response by default  
  2. config.Formatters.JsonFormatter.SupportedMediaTypes.Add(new MediaTypeHeaderValue("text/html"));  

Step 7: Testing WEB API

Here I used the "Poster for Firefox" plugin to test the output. You can directly download this plugin from the Plugin directory of Firefox:



Just enter the URI and press GET or whatever you want to play, you will get the output accordingly.



Conclusion

I hope you enjoyed this article. I tried to make this as simple as I can. If you like this article, please rate it and share it to share the knowledge.

  • Do try to extend this application with more complex data
  • In future articles we will see how to consume the Web API using various REST clients such as RestSharp, ASP.Net and so on.
  • You can download the complete code from GitHub.
    You can find a demo here: Demo-webapi


Similar Articles