当前位置:首页 > C# > 正文

使用C#构建Web API(ASP.NET Core Web API入门与实战教程)

在现代软件开发中,ASP.NET Core Web API 是构建高性能、跨平台 RESTful 接口的首选框架之一。无论你是刚接触后端开发的新手,还是希望快速上手 C# Web API 开发的开发者,本教程都将带你从零开始创建一个完整的 Web API 项目。

使用C#构建Web API(ASP.NET Core Web API入门与实战教程) ASP.NET API  C# API开发 创建RESTful接口 .NET API教程 第1张

一、准备工作

在开始之前,请确保你已安装以下工具:

  • .NET SDK(推荐 .NET 6 或更高版本)
  • Visual Studio 2022 或 Visual Studio Code

二、创建 ASP.NET Core Web API 项目

打开终端(或命令提示符),执行以下命令创建新项目:

dotnet new webapi -n MyFirstApicd MyFirstApi  

该命令会基于 C# Web API开发 模板生成一个基础项目结构,包含控制器、Program.cs 等核心文件。

三、理解项目结构

项目生成后,你会看到如下关键文件:

  • Program.cs:应用入口点,配置服务和中间件。
  • Controllers/WeatherForecastController.cs:默认示例控制器。

四、创建自己的 RESTful 接口

我们将创建一个简单的“用户管理”API。首先,在项目根目录下新建一个 Models 文件夹,并添加 User.cs 类:

namespace MyFirstApi.Models{    public class User    {        public int Id { get; set; }        public string? Name { get; set; }        public string? Email { get; set; }    }}  

接着,在 Controllers 文件夹中创建 UsersController.cs

using Microsoft.AspNetCore.Mvc;using MyFirstApi.Models;[ApiController][Route("[controller]")]public class UsersController : ControllerBase{    // 模拟数据库    private static List<User> _users = new()    {        new() { Id = 1, Name = "张三", Email = "zhangsan@example.com" },        new() { Id = 2, Name = "李四", Email = "lisi@example.com" }    };    [HttpGet]    public ActionResult<List<User>> GetAll()    {        return _users;    }    [HttpGet("{id}")]    public ActionResult<User> GetById(int id)    {        var user = _users.FirstOrDefault(u => u.Id == id);        if (user == null)            return NotFound();        return user;    }    [HttpPost]    public ActionResult<User> Create(User user)    {        user.Id = _users.Max(u => u.Id) + 1;        _users.Add(user);        return CreatedAtAction(nameof(GetById), new { id = user.Id }, user);    }}  

这段代码展示了如何实现基本的 CRUD 操作中的“读取”和“创建”,是典型的 创建RESTful接口 实践。

五、运行并测试 API

在终端中运行:

dotnet run  

启动成功后,默认监听 https://localhost:7000(具体端口可能不同)。你可以使用浏览器或 Postman 访问:

  • GET /users → 获取所有用户
  • GET /users/1 → 获取 ID 为 1 的用户
  • POST /users → 创建新用户(需发送 JSON 数据)

六、总结

通过本教程,你已经掌握了使用 .NET Core API教程 中的核心步骤:创建项目、定义模型、编写控制器、实现 RESTful 路由。这些技能是构建现代 Web 服务的基础。

继续深入学习,你可以探索身份验证、数据库集成(如 Entity Framework Core)、Swagger 文档生成等高级功能。

关键词回顾:ASP.NET Core Web APIC# Web API开发创建RESTful接口.NET Core API教程