C#版ASP.NET WebAPI使用示例

什么是ASP.NET WebAPI

ASP.NET Web API是一个开放源代码的framework，用于构建HTTP服务，可以轻松地开发出支持各种客户端的REST API。ASP.NET Web API具有简单易用的结构，并且在开发中可以与其他ASP.NET功能（如MVC）很好地集成。

开始使用ASP.NET WebAPI

首先在Visual Studio中创建一个ASP.NET WebAPI项目。通过选择文件 -> 新建 -> 项目 -> Web -> ASP.NET Web应用程序，选择Web API作为模板即可创建出一个基本的WebAPI项目。

定义API

在ASP.NET WebAPI中，API是由控制器和操作（Action）定义的。控制器是类，操作是类中的方法。下面示例代码中，定义了一个名为ProductController的控制器，其中包含一个操作GetProduct。

public class ProductController : ApiController
{
    public string GetProduct(int id)
    {
        return "Product id = " + id;
    }
}

使用API

定义好API后，可以通过HTTP请求访问API。例如，使用浏览器访问api/Product/5，就可以调用ProductController中的GetProduct(5)方法，并返回结果Product id = 5。

进一步定制化

在上面的例子中，返回值是一个字符串。实际开发中，我们可能需要返回更详细的数据，例如JSON或XML格式的数据。可以在值的类型前加上属性[ResponseType]，就可以指定返回的数据类型。

[ResponseType(typeof(Product))]
public IHttpActionResult GetProduct(int id)
{
    Product product = db.Products.Find(id);
    if (product == null)
    {
        return NotFound();
    }

    return Ok(product);
}

结论

ASP.NET WebAPI是开发RESTful API的最佳选择之一，它很容易上手，也可以高度定制化。在实际开发中，我们可以运用ASP.NET WebAPI来开发各种类型的API应用，例如移动端API应用、Web端API应用以及第三方API应用等。