WebAPI For EntAppFrameWork Handbook

WebAPI

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.

Chinese version

URI Pattern

Code And Implementation

BaseController is ApiBaseController

public class HTEController : ApiBaseController
{

}

Action And Model

Use Attribute([HttpGet]、[HttpPost]、[HttpPut]、[HttpDelete])

Define return model in webAPI,attribute name first letter should be lowercase.

public class HTEController : ApiBaseController
{
    [HttpGet]
    public HTEModel GetHTEModel(Int64 id)
    {
        HTEModel hTEModel = new HTEModel();
        HTE hte = EntAppFrameWork.EntAppFrameWorkContext.DomainModelService.ExtenedService<IHTE>().GetHteByHteId(id);
        hTEModel.HTEName = hte.Name;
        hTEModel.Score = hte.Score.ToString();
        hTEModel.HTEType = hte.HTEType;
        hTEModel.StartTime = hte.PublishDateTime;
        hTEModel.EndTime = hte.EndTime;
        Collection<IncludeExerciseModel> exercises = new Collection<IncludeExerciseModel>();
        if (hte.Exercises != null)
        {
            foreach (var item in hte.Exercises)
            {
                IncludeExerciseModel includeExerciseModel = new IncludeExerciseModel();
                includeExerciseModel.ExerciseId = item.Exercise.Key;
                includeExerciseModel.Score = item.Score.ToString();
                includeExerciseModel.Sequence = item.Sequence;
                exercises.Add(includeExerciseModel);
            }
        }
        hTEModel.Exercises = exercises;
        return hTEModel;
    }
}



public class HTEModel
{
    public string hTEName { get; set; }
    public DateTime startTime { get; set; }
    public DateTime endTime { get; set; }
    public string score { get; set; }
    public Collection<IncludeExerciseModel> exercises { get; set; }
    public HTEType hTEType { get; set; }
}

Parameter Data Transfer Object

A DTO is a simple container for a set of aggregated data that needs to be transferred across a process or network boundary.

    [HttpPost]
    public Int64 CreateFullHTE([FromBody]CreateFullHTEDTO createFullHTEDTO)
    {
        var hteID = EntAppFrameWork.EntAppFrameWorkContext.DomainModelService.ExtenedService<IHTE>().CreateFullHTE(createFullHTEDTO.HteName,createFullHTEDTO.Generatetype,createFullHTEDTO.HTEType,createFullHTEDTO.Exercises,createFullHTEDTO.CourseId,createFullHTEDTO.UserId, createFullHTEDTO.StartTime, createFullHTEDTO.EndTime);
        return hteID;
    }



    public class CreateFullHTEDTO
    {
        public string HteName { get; set; }
        public GenerateType Generatetype { get; set; }
        public HTEType HTEType { get; set; }
        public List<IncludeExerciseDto> Exercises { get; set; }
        public Int64 CourseId { get; set; }
        public Int64 UserId { get; set; }
        public DateTime StartTime { get; set; }
        public DateTime EndTime { get; set; }
    }

Authentication

Security tokens are used to prove one's identity electronically. The token is used in addition to or in place of a password to prove that the customer is who they claim to be. The token acts like an electronic key to access something.

Use authentication

/Controller/Action?ssotoken=XXXX

No authentication

 [AllowAnonymousAttribute]
public class XXController : ApiBaseController
{

}

Exception Handling

{
    "ErrorCode":"300300010",
    "Data":"",
    "ErrorMessage":"Exercise not find"
}

Help Page

Introduction

In this article we will define how to add the Test Client to the ASP. NET Web API help page.

Step 1

First we create the help page. For creating the help page use this link: Creating the Help Page in ASP. NET Web API.

Step 2

Install the test client package using the following procedure:

• Go to Tools.
• choose "Library Package Manager" -> "Manage Nuget Packages" for the solution.
• It is opened like this:

• Make sure to "Include Prerelease".
• Type "webapitestclient" in the search TextBox in the top-right corner.

• Now click on install for installing it.

When the Web API Test Client is installed, the following files will be added to your application:

• Scripts\WebApiTestClient.js
• Areas\HelpPage\TestClient.css
• Areas\HelpPage\views\Help\Display Template\TestClientReferences.cshtml
• Areas\HelpPage\views\Help\Display Template\TestClientDialogs.cshtml

Step 3

Now write the Test Client on the help page.
For selecting the Api.cshtml, go to the Solution Explorer and choose "Areas\HelpPage\Views\Help\Display Templates\Api.cshtml".

We add the following code in the Api.cshtml file that is @Html.DisplayForModel("TestClientDialogs"). We can add this code after the

@using System.Web.Http
@using MvcApplication4.Areas.HelpPage.Models
@model HelpPageApiModel

@{
    var description = Model.ApiDescription;
    ViewBag.Title = description.HttpMethod.Method + " " + description.RelativePath;
}

<div id="body">
    <section class="featured">
        <div class="content-wrapper">
            <p>
                @Html.ActionLink("Help Page Home", "Index")
            </p>
        </div>
    </section>
    <section class="content-wrapper main-content clear-fix">
        @Html.DisplayFor(m => Model)
    </section>
</div>
@Html.DisplayForModel("TestClientDialogs")
@section Scripts {
    <link type="text/css" href="~/Areas/HelpPage/HelpPage.css" rel="stylesheet" />
    @Html.DisplayForModel("TestClientReferences")
}

@using System.Text.RegularExpressions
<script src="~/Scripts/jquery-1.8.2.js"></script>
<script src="~/Scripts/knockoutjs%202.1.0.js"></script>
<script src="~/Scripts/jquery-ui-1.10.3.js"></script>
<link href="~/Content/themes/base/jquery.ui.all.css" rel="stylesheet" />
<link href="~/Areas/HelpPage/TestClient.css" rel="stylesheet" />
@* Automatically grabs the installed version of JQuery/JQueryUI/KnockoutJS *@
@{var filePattern = @"(jquery-[0-9]+.[0-9]+.[0-9]+.js|jquery-ui-[0-9]+.[0-9]+.[0-9]+.js|knockout-[0-9]+.[0-9]+.[0-9]+.js)";}
@foreach (var item in Directory.GetFiles(Server.MapPath(@"~/Scripts")).Where(f => Regex.IsMatch(f, filePattern)))
{
    <script src="~/Scripts/@Path.GetFileName(item)"></script>
}
<script src="~/Scripts/WebApiTestClient.js" defer="defer"></script>