ASP.NET Web API是构建基于HTTP的服务的理想框架，支持多种客户端包括浏览器、移动设备和桌面应用调用，遵循RESTful设计风格可以大幅提升接口的可维护性和扩展性。
创建ASP.NET Web API项目
首先打开Visual Studio，选择创建新项目，在项目模板中搜索ASP.NET_Web_API，选择对应的模板后点击下一步。设置项目名称和存储路径，框架选择.NET Framework 4.7.2及以上版本，点击创建后在弹出的选项里选择空模板，勾选Web API核心引用，完成项目创建。
编写API控制器与接口
控制器是ASP.NET Web API处理请求的核心组件，默认放在Controllers文件夹下。我们创建一个处理用户信息的控制器，实现基础的增删改查接口。
using System.Collections.Generic;
using System.Web.Http;
// 用户模型类
public class User
{
public int Id { get; set; }
public string Name { get; set; }
public int Age { get; set; }
}
// 用户控制器，继承ApiController
public class UserController : ApiController
{
// 模拟用户数据存储
private static List<User> users = new List<User>
{
new User { Id = 1, Name = "张三", Age = 25 },
new User { Id = 2, Name = "李四", Age = 28 }
};
// GET api/user 获取所有用户
public IEnumerable<User> GetAllUsers()
{
return users;
}
// GET api/user/1 根据id获取单个用户
public IHttpActionResult GetUserById(int id)
{
var user = users.Find(u => u.Id == id);
if (user == null)
{
return NotFound();
}
return Ok(user);
}
// POST api/user 新增用户
public IHttpActionResult AddUser(User user)
{
if (user == null)
{
return BadRequest("用户信息不能为空");
}
user.Id = users.Count + 1;
users.Add(user);
return Created($"api/user/{user.Id}", user);
}
// PUT api/user/1 更新用户信息
public IHttpActionResult UpdateUser(int id, User updatedUser)
{
var user = users.Find(u => u.Id == id);
if (user == null)
{
return NotFound();
}
user.Name = updatedUser.Name;
user.Age = updatedUser.Age;
return Ok(user);
}
// DELETE api/user/1 删除用户
public IHttpActionResult DeleteUser(int id)
{
var user = users.Find(u => u.Id == id);
if (user == null)
{
return NotFound();
}
users.Remove(user);
return StatusCode(System.Net.HttpStatusCode.NoContent);
}
}
配置路由规则
ASP.NET Web API的路由规则默认配置在App_Start文件夹下的WebApiConfig.cs文件中，默认路由格式为api/{controller}/{id}，其中id是可选参数。如果需要自定义路由，可以在控制器方法上添加Route特性。
using System.Web.Http;
public static class WebApiConfig
{
public static void Register(HttpConfiguration config)
{
// 默认路由配置
config.Routes.MapHttpRoute(
name: "DefaultApi",
routeTemplate: "api/{controller}/{id}",
defaults: new { id = RouteParameter.Optional }
);
// 可选：配置返回JSON格式，避免XML序列化
var appXmlType = config.Formatters.XmlFormatter.SupportedMediaTypes.FirstOrDefault(t => t.MediaType == "application/xml");
if (appXmlType != null)
{
config.Formatters.XmlFormatter.SupportedMediaTypes.Remove(appXmlType);
}
}
}
使用HttpClient调用API接口
前端或者其他后端服务可以通过HttpClient来调用ASP.NET Web API接口，以下是C#中使用HttpClient调用上述用户接口的完整示例。
using System;
using System.Net.Http;
using System.Text;
using Newtonsoft.Json;
class Program
{
static void Main(string[] args)
{
// 接口基础地址，本地调试默认端口为项目启动端口
string baseUrl = "http://localhost:12345/";
using (HttpClient client = new HttpClient())
{
client.BaseAddress = new Uri(baseUrl);
// 1. 调用获取所有用户接口
var response = client.GetAsync("api/user").Result;
if (response.IsSuccessStatusCode)
{
var users = response.Content.ReadAsStringAsync().Result;
Console.WriteLine("所有用户：" + users);
}
// 2. 调用新增用户接口
var newUser = new { Name = "王五", Age = 30 };
var json = JsonConvert.SerializeObject(newUser);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var addResponse = client.PostAsync("api/user", content).Result;
Console.WriteLine("新增用户结果：" + addResponse.Content.ReadAsStringAsync().Result);
// 3. 调用更新用户接口
var updateUser = new { Name = "张三更新", Age = 26 };
json = JsonConvert.SerializeObject(updateUser);
content = new StringContent(json, Encoding.UTF8, "application/json");
var updateResponse = client.PutAsync("api/user/1", content).Result;
Console.WriteLine("更新用户结果：" + updateResponse.Content.ReadAsStringAsync().Result);
}
}
}
常见问题处理
- 接口返回404：检查路由配置是否正确，控制器是否继承ApiController，方法访问修饰符是否为public。
- 参数绑定失败：POST和PUT请求的复杂参数需要放在请求体中，并且请求头Content-Type设置为application/json。
- 跨域问题：如果前端和API不在同一个域，需要在项目中安装Microsoft.AspNet.WebApi.Cors包，然后在WebApiConfig中启用跨域配置。
注意：实际生产环境中需要对接口添加身份验证和授权机制，避免接口被未授权访问，同时需要对输入参数做合法性校验，防止恶意请求。
ASP.NET_Web_APIRESTful接口HttpClient控制器路由配置修改时间：2026-07-13 14:48:30