在软件开发过程中，Web API 是一种非常流行的服务架构，它使得不同系统或应用程序之间可以通过网络进行通信。C# 语言结合 .NET 平台提供了一个强大且高效的环境来开发 Web API。本文将介绍如何利用 C# 搭建一个基本的 Web API 服务，并提供相关代码示例。
一、环境准备
在开始之前，你需要确保你的开发环境已安装以下组件： - .NET SDK（可以从 Microsoft 官网 下载） - IDE（推荐使用 Visual Studio 或 Visual Studio Code）
二、创建项目
首先，打开命令行工具，使用以下命令创建一个新的 ASP.NET Core Web API 项目：
dotnet new webapi -n MyWebApi
cd MyWebApi
这将创建一个名为 MyWebApi 的新项目，并进入到该项目目录下。
三、项目结构
创建好项目后，通常会看到以下的目录结构：
- Controllers: 存放控制器的文件夹
- Models: 可以存放数据模型的文件夹
- Program.cs: 应用程序的入口点
- Startup.cs: 配置服务和请求管道的文件
四、编写模型
在 Models 文件夹中创建一个 Product.cs 文件，定义一个产品的模型：
namespace MyWebApi.Models
{
public class Product
{
public int Id { get; set; }
public string Name { get; set; }
public decimal Price { get; set; }
}
}
五、创建控制器
接下来，在 Controllers 文件夹中创建一个 ProductsController.cs 文件，负责处理产品相关的 HTTP 请求：
using Microsoft.AspNetCore.Mvc;
using MyWebApi.Models;
using System.Collections.Generic;
using System.Linq;
namespace MyWebApi.Controllers
{
[ApiController]
[Route("[controller]")]
public class ProductsController : ControllerBase
{
private static List<Product> products = new List<Product>
{
new Product { Id = 1, Name = "Product1", Price = 100 },
new Product { Id = 2, Name = "Product2", Price = 200 },
};
// GET: /products
[HttpGet]
public ActionResult<List<Product>> Get()
{
return Ok(products);
}
// GET: /products/{id}
[HttpGet("{id}")]
public ActionResult<Product> Get(int id)
{
var product = products.FirstOrDefault(p => p.Id == id);
if (product == null)
{
return NotFound();
}
return Ok(product);
}
// POST: /products
[HttpPost]
public ActionResult<Product> Post([FromBody] Product product)
{
product.Id = products.Max(p => p.Id) + 1; // 自动生成 ID
products.Add(product);
return CreatedAtAction(nameof(Get), new { id = product.Id }, product);
}
}
}
六、运行应用
在终端中运行以下命令以启动 API 服务：
dotnet run
默认情况下，应用将运行在 http://localhost:5000。
七、测试 API
你可以使用 Postman 或浏览器等工具测试你的 API 服务。例如：
- 获取所有产品：
- 请求类型：GET
-
URL:
http://localhost:5000/products -
获取单个产品：
- 请求类型：GET
-
URL:
http://localhost:5000/products/1 -
添加新产品：
- 请求类型：POST
- URL:
http://localhost:5000/products - 请求体（JSON）：
json { "Name": "Product3", "Price": 150 }
总结
通过以上步骤，你成功地搭建了一个简单的 Web API 服务。你可以在此基础上扩展更多功能，比如添加数据验证、中间件、数据库连接等，以满足实际项目的需求。希望本文能帮助你快速上手 C# Web API 开发！
