Shulou(Shulou.com)06/02 Report--

This article mainly introduces "ASP.NET Web API sample Analysis". In daily operation, I believe many people have doubts about ASP.NET Web API sample analysis. The editor consulted all kinds of data and sorted out simple and easy-to-use operation methods. I hope it will be helpful to answer the doubts of "ASP.NET Web API sample Analysis". Next, please follow the editor to study!

ASP.NET Web API demo exampl

Basic configuration of environment

First, we create a new class library project named Common, and define a product information type. The sample code is as follows:

Code 1-1

NamespaceCommon {publicclassProduct {publicstringProductID {get; set;} publicstringProductName {get; set;} publicstringProductCategory {get; set;}

Establish a WebHost hosting environment

Then we go on to create an empty ASP.NET WEB application named WebHost, which shows that the ASP.NET Web API framework is just a stand-alone framework, and it does not run independently, so it needs a hosting environment. The new WEB application we just created will temporarily host the ASP.NET Web API framework in the following example.

Reference assembly

Newtonsoft.Json.dll path: C:\ Program Files\ Microsoft ASP.NET\ ASP.NET MVC 4\ Packages\ Newtonsoft.Json.4.5.6\ lib\ net40Newtonsoft.Json.dll

System.Net.Http.dll path: C:\ Program Files\ Microsoft ASP.NET\ ASP.NET MVC 4\ Assemblies\ System.Net.Http.dll

System.Net.Http.Formatting.dll path: C:\ Program Files\ Microsoft ASP.NET\ ASP.NET MVC 4\ Assemblies\ System.Net.Http.Formatting.dll

System.Web.Http.dll path: C:\ Program Files\ Microsoft ASP.NET\ ASP.NET MVC 4\ Assemblies\ System.Web.Http.dll

System.Web.Http.WebHost.dll path: C:\ Program Files\ Microsoft ASP.NET\ ASP.NET MVC 4\ Assemblies\ System.Web.Http.WebHost.dll

Common.dll (project reference)

Or use this way of citation:

(if the directory location described above does not have Newtonsoft.Json.dll, you can search for the file and then reference it manually. )

Then we set up a Web application processing class Globl.asax and register the route in its Application_Start () method. The example code is as follows:

Code 1-2

UsingSystem.Web.Http; namespaceWebHost {publicclassGlobal: System.Web.HttpApplication {protectedvoidApplication_Start (objectsender, EventArgse) {GlobalConfiguration.Configuration.Routes.MapHttpRoute ("DefaultAPI", "api/ {controller} / {id}", new {controller= "product", id=RouteParameter.Optional});}

After the route is registered, we need to create a new Web API controller, named ProductController. The sample code is as follows:

Code 1-3

UsingSystem.Web.Http;usingCommon; namespaceWebHost.Controllers {publicclassProductController:ApiController {privatestaticListproducts; staticProductController () {products=newList () Products.AddRange (newProduct [] {newProduct () {ProductID= "001", ProductName= "toothbrush", ProductCategory= "toiletries"}, newProduct () {ProductID= "002", ProductName= ".NET Framework Design-Art of large Enterprise Application Framework Design", ProductCategory= "Books"}) } publicIEnumerableGet (stringid=null) {returnfromproductinproductswhereproduct.ProductID==id | | string.IsNullOrEmpty (id) selectproduct;}

In code 1-3, we see that the ProductController controller inherits from ApiController. My guess here is that after the request arrives and after routing, the Web API framework looks up all the referenced assemblies in the current project and finds the types inherited from ApiController, and caches a xml file. I don't know whether the conjecture is correct or not. Let's verify it again in the following space. I'll mention it here.

Careful friends may find that there is no corresponding Action routing parameters when routing registration, in fact, this is a difference of the Web API framework, it is based on the Http request method to determine the Action method, however, the browser default request method is Http-get, so we can directly run the project at this time.

Figure 2

Establish SelfHost

Let's take a look at an example of using the ASP.NET Web API framework in a SelfHost hosting environment.

First of all, we create a new console application named SelfHost,SelfHost environment project assembly reference and the only difference between the WebHost project reference and the WebHost project reference is to replace the System.Web.Http.WebHost.dll assembly with the System.Web.Http.SelfHost.dll assembly, with the reference path unchanged, or you can use the extension bar in the reference to add.

Let's take a look at what we need to do in SelfHost. First, we need to register the route, which is the first thing to do each time. The sample code is as follows:

Code 1-4

UsingSystem.Web.Http;usingSystem.Web.Http.SelfHost; namespaceSelfHost {classProgram {staticvoidMain (string [] args) {HttpSelfHostConfigurationselfHostConfiguration= newHttpSelfHostConfiguration ("http://localhost/selfhost"); Using (HttpSelfHostServerselfHostServer=newHttpSelfHostServer (selfHostConfiguration)) {selfHostServer.Configuration.Routes.MapHttpRoute ("DefaultApi", "api/ {controller} / {id}", new {id=RouteParameter.Optional}); selfHostServer.OpenAsync (); Console.WriteLine ("server-side service monitoring is enabled"); Console.Read () }

Here is a brief explanation. The base address is set in the example of the HttpSelfHostConfiguration object in the 1-4 code. For the HttpSelfHostConfiguration type, it inherits from the HttpConfiguration type, and the HttpConfiguration type is an important type. Most of the configuration information in the WebAPI framework is set in this type instance. It will be mentioned in the following pages.

The HttpSelfHostServer object plays an important role in the SelfHost hosting environment, and it is responsible for a series of operations such as processing requests (because it is the "faucet" of the pipeline model of the WebAPI framework in the SelfHost environment). You only need to know a little about it here, and it will be unveiled in the following pipeline space.

Looking further down, we will see that the Routes attribute in the Configuration property in the HttpSelfHostServer object instance provides the registration of routes, which will be explained in the routing section below.

And then what we see, turn on the service monitor and wait for the request to be processed. (the monitoring / processing request here is not to process the real request, but to process the objects that have been encapsulated in the request, as explained in the pipeline.)

After the route registration, we need to create a new Web API controller, just like the WebHost section above, and make a copy of it. However, we need to modify the controller code slightly. The sample code is as follows:

Code 1-5

UsingSystem.Web.Http;usingCommon; namespaceSelfHost.Controllers {publicclassProductController:ApiController {privatestaticListproducts; staticProductController () {products=newList () Products.AddRange (newProduct [] {newProduct () {ProductID= "001", ProductName= "toothbrush", ProductCategory= "toiletries"}, newProduct () {ProductID= "002", ProductName= ".NET Framework Design-Art of large Enterprise Application Framework Design", ProductCategory= "Books"}) } publicIEnumerableGet (stringid=null) {returnfromproductinproductswhereproduct.ProductID==id | | string.IsNullOrEmpty (id) selectproduct;} publicvoidDelete (stringid) {products.Remove (products.First (product= > product.ProductID==id));} publicvoidPost (Productproduct) {products.Add (product) } publicvoidPut (Productproduct) {Delete (product.ProductID); Post (product);}

For several new Action methods added to the controller in Code 1-5, they also correspond to Http request methods. In this way, the basic function of adding, deleting, changing and searching can be realized. Then we also need a client to access it.

Establish Clinet

Let's build another console application named Clinet and add the following assembly reference:

Newtonsoft.Json.dll path: C:\ Program Files\ Microsoft ASP.NET\ ASP.NET MVC 4\ Packages\ Newtonsoft.Json.4.5.6\ lib\ net40Newtonsoft.Json.dll

System.Net.Http.dll path: C:\ Program Files\ Microsoft ASP.NET\ ASP.NET MVC 4\ Assemblies\ System.Net.Http.dll

System.Net.Http.Formatting.dll path: C:\ Program Files\ Microsoft ASP.NET\ ASP.NET MVC 4\ Assemblies\ System.Net.Http.Formatting.dll

Common.dll (project reference)

Let's take a look at an example of accessing resources in the SelfHost environment in the Client project. The sample code is as follows:

Code 1-6

UsingCommon;usingSystem.Net.Http; namespaceClient {classProgram {staticvoidMain (string [] args) {AsyncProcess (); Console.Read ();} privateasyncstaticvoidAsyncProcess () {HttpClienthttpClient=newHttpClient (); / / get item information list HttpResponseMessageresponseMessage= awaithttpClient.GetAsync ("http://localhost/selfhost/api/product"); IEnumerableproducts=awaitresponseMessage.Content.ReadAsAsync (); OutputProductInfo (products); / / add goods Productproduct=newProduct () {ProductID= "003", ProductName= "" ASP.NET Web API 2 Framework reveals ", ProductCategory=" Food "} AwaithttpClient.PostAsJsonAsync ("http://localhost/selfhost/api/product", product); responseMessage=awaithttpClient.GetAsync (" http://localhost/selfhost/api/product"); products=awaitresponseMessage.Content.ReadAsAsync (); OutputProductInfo (products); / / modify the specified item information responseMessage=awaithttpClient.GetAsync ("http://localhost/selfhost/api/product/003");") Product= (awaitresponseMessage.Content.ReadAsAsync ()). First (); product.ProductCategory= "books"; awaithttpClient.PutAsJsonAsync ("http://localhost/selfhost/api/product", product); responseMessage=awaithttpClient.GetAsync (" http://localhost/selfhost/api/product"); products=awaitresponseMessage.Content.ReadAsAsync (); OutputProductInfo (products)) " / / Delete the specified goods awaithttpClient.DeleteAsync ("http://localhost/selfhost/api/product/001"); responseMessage=awaithttpClient.GetAsync (" http://localhost/selfhost/api/product"); products=awaitresponseMessage.Content.ReadAsAsync (); OutputProductInfo (products)) } privatestaticvoidOutputProductInfo (IEnumerableproducts) {foreach (Productproductinproducts) {Console.WriteLine ("ProductID: {0}, ProductName: {1}, ProductCategorm: {2}", product.ProductID, product.ProductName, product.ProductCategory) } Console.WriteLine ("-");} at this point, the study of "ASP.NET Web API sample Analysis" is over. I hope to be able to solve your doubts. The collocation of theory and practice can better help you learn, go and try it! If you want to continue to learn more related knowledge, please continue to follow the website, the editor will continue to work hard to bring you more practical articles!

Welcome to subscribe "Shulou Technology Information " to get latest news, interesting things and hot topics in the IT industry, and controls the hottest and latest Internet news, technology news and IT industry trends.