C# Web API如何入门？从零开始构建一个RESTful风格的C#后端服务

技术教程
2025-11-24 19:29:02

从零开始用C#构建RESTful后端服务需先安装.NET SDK并选择编辑器，通过dotnet new webapi创建项目，理解Program.cs、控制器和配置文件结构，接着创建BooksController实现GET、POST等API，最后用Swagger或curl测试接口。

c# web api如何入门？从零开始构建一个restful风格的c#后端服务

想用C#构建一个RESTful风格的后端服务？从零开始并不难。只要掌握ASP.NET Core Web API的基本结构和开发流程，你很快就能搭建出功能完整的后端接口。下面一步步带你入门。

1. 准备开发环境

要开始开发C# Web API，先确保你的开发环境已经就绪：

安装 .NET SDK：前往微软官网下载并安装最新版的 .NET SDK（推荐 .NET 6 或更高版本）
选择代码编辑器：Visual Studio 2025、Visual Studio Code 或 Rider 都可以。VS Code 搭配 C# 插件轻量高效
验证安装：打开终端输入 dotnet --version，确认版本显示正常

2. 创建第一个Web API项目

使用命令行快速创建项目：

dotnet new webapi -n MyFirstApi

进入项目目录：

cd MyFirstApi

运行项目：

dotnet run

浏览器访问 https://localhost:5001/weatherforecast，你会看到返回的JSON数据 —— 这就是默认生成的示例API。

3. 理解项目结构和核心文件

关键文件说明：

GPT-MINUS1

通过在文本中随机地用同义词替换单词来愚弄GPT

153 查看详情 GPT-MINUS1

Program.cs：程序入口，配置服务和中间件（如路由、Swagger）
Controllers/：存放控制器类，每个Controller处理一组HTTP请求
appsettings.json：配置文件，可设置连接字符串、日志等
Properties/launchSettings.json：定义启动时的端口和环境

注意：ASP.NET Core 6+ 使用了“隐式 using”和简化入口代码，所有逻辑集中在 Program.cs 中。

4. 创建自己的RESTful控制器

比如我们要做一个图书管理API。新建一个类 BooksController.cs：

using Microsoft.AspNetCore.Mvc;

namespace MyFirstApi.Controllers;

[ApiController]
[Route("api/[controller]")]
public class BooksController : ControllerBase
{

private static List books = new() { "《C#入门》", "《ASP.NET实战》" };

[HttpGet]
public IActionResult Get() => Ok(books);

[HttpGet("{id}")]
public IActionResult GetById(int id)
{
if (id >= books.Count || id return Ok(books[id]);
}

[HttpPost]
public IActionResult Add([FromBody] string title)
{
books.Add(title);
return CreatedAtAction(nameof(GetById), new { id = books.Count - 1 }, title);
}
}

保存后，重启服务或启用热重载。访问 /api/books 就能看到图书列表。

5. 测试你的API

推荐使用工具测试接口：

Swagger UI：项目自带，运行后访问 https://localhost:5001/swagger 可视化测试所有接口
Postman 或 curl：发送 POST 请求测试添加图书功能
例如用 curl 添加一本书：
curl -X POST https://localhost:5001/api/books -H "Content-Type: application/json" -d "\"《数据库设计》\""