Web API tutorial

Web API

First, we can refer to this link.

Here, we make a quick tutorial. we build restful api using MVC Web API

  1. First Controller, In this Sample, we need to note these things.

1.1 Controller should inherite from ApiController.

1.2 For each Api, it is just a function. We need to specify the Route , HttpMethod, ReturnType.
Route, MSDN, we can provide url only, as it is shown below.
or along with the RouteName. For Detail About Route, we can refer Link

1.3 For the returnType of the webapi, it Can be HttpResponseMessage, or concrete Type of ViewModel. Detail explanation of HttpResponseMessage.

code Sample:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Web.Http;
using ERPWeb.ViewModel;

namespace ERPWeb.Api.Controllers
{
    public class ProductsController : ApiController
    {
        [HttpGet]
        [Route("api/Products")]
        public HttpResponseMessage GetAll()
        {
            List<ProductViewModel> productList = new List<ProductViewModel>();
            productList.Add(new ProductViewModel() { Id = 1, Name = "Product1", Size = 50, Count = 1000 });
            productList.Add(new ProductViewModel() { Id = 2, Name = "Product2", Size = 57, Count = 1000 });
           // return Request.CreateErrorResponse(HttpStatusCode.NotFound,"not found");
            return Request.CreateResponse(HttpStatusCode.OK, productList);
        }

        [HttpGet]
        [Route("api/Products/{Id}")]
        public HttpResponseMessage Get(int Id)
        {
            ProductViewModel pvm = new ProductViewModel() { Id = 2, Name = "Product2", Size = 57, Count = 1000 };
            return Request.CreateResponse(HttpStatusCode.OK, pvm);
        }

        [HttpPatch]
        [HttpPut]
        [Route("api/Products/{Id}")]
        public HttpResponseMessage Put(int Id,[FromBody] ProductViewModel updatedProduct)
        {
            updatedProduct.Name = "OK";
            return Request.CreateResponse(HttpStatusCode.OK, updatedProduct);
        }

        [HttpPost]
        [Route("api/Products")]
        public HttpResponseMessage Post([FromBody] ProductViewModel pvm)
        {
            pvm.Id = 3;
            pvm.Name = "Ok";
            return Request.CreateResponse(HttpStatusCode.OK, pvm);
        }

        [HttpDelete]
        [Route("api/Products/{Id}")]
        public HttpResponseMessage Delete(int Id)
        {
            if(Id==1)
            {
                return Request.CreateResponse(HttpStatusCode.OK);
            }
            else
            {
                return Request.CreateErrorResponse(HttpStatusCode.NotFound, "error");
            }
        }
    }
}
posted @   kongshu  阅读(120)  评论(0编辑  收藏  举报
编辑推荐:
· 10年+ .NET Coder 心语,封装的思维:从隐藏、稳定开始理解其本质意义
· .NET Core 中如何实现缓存的预热?
· 从 HTTP 原因短语缺失研究 HTTP/2 和 HTTP/3 的设计差异
· AI与.NET技术实操系列:向量存储与相似性搜索在 .NET 中的实现
· 基于Microsoft.Extensions.AI核心库实现RAG应用
阅读排行:
· TypeScript + Deepseek 打造卜卦网站:技术与玄学的结合
· 阿里巴巴 QwQ-32B真的超越了 DeepSeek R-1吗?
· 【译】Visual Studio 中新的强大生产力特性
· 10年+ .NET Coder 心语 ── 封装的思维:从隐藏、稳定开始理解其本质意义
· 【设计模式】告别冗长if-else语句:使用策略模式优化代码结构
点击右上角即可分享
微信分享提示