当前位置:

首页 > 编程开发 > C# 创建RESTful API教程详解

C# 创建RESTful API教程详解

使用ASP.NETCore创建RESTfulAPI:安装.NETSDK后,通过dotnetnewwebapi命令创建项目,定义Product模型和ProductsController实现CRUD操作,运行dotnetrun启动服务,访问https://localhost:5001/swagger测试接口,可选集成EntityFrameworkCore支持数据库,并通过dotnetpublish部署应用。

本文目录

    使用ASP.NET Core创建RESTful API:安装.NET SDK后,通过dotnet new webapi命令创建项目,定义Product模型和ProductsController实现CRUD操作,运行dotnet run启动服务,访问https://localhost:5001/swagger测试接口,可选集成Entity Framework Core支持数据库,并通过dotnet publish部署应用。

    C# 如何创建一个 RESTful API_C# RESTful API 开发完整教程

    要使用 C# 创建一个 RESTful API,最常用的方式是通过 ASP.NET Core。它轻量、跨平台,并且非常适合构建现代 Web API。下面是一个完整的入门教程,带你从零开始创建一个简单的 RESTful API。

    1. 准备开发环境

    确保你已安装以下工具:

    • .NET SDK(建议 6.0 或更高版本)
    • Visual Studio(2022 推荐)或 Visual Studio Code
    • 终端/命令行工具

    你可以通过运行 dotnet --version 检查是否已安装 .NET SDK。

    2. 创建 Web API 项目

    打开终端,执行以下命令创建一个新的 Web API 项目:

    dotnet new webapi -n MyRestApi
    cd MyRestApi
    dotnet run

    项目创建完成后,默认会在 http://localhost:5000 启动服务,访问 https://localhost:5001/weatherforecast 可看到示例数据。

    3. 理解项目结构

    关键文件和目录说明:

    • Program.cs:应用入口,配置服务和中间件(.NET 6+ 使用隐式 using 和顶级语句)
    • Controllers 文件夹:存放控制器类,处理 HTTP 请求
    • appsettings.json:配置文件,如数据库连接字符串
    • Properties/launchSettings.json:本地运行配置

    4. 创建自己的数据模型

    添加一个表示“产品”的类:

    public class Product
    {
    public int Id { get; set; }
    public string Name { get; set; } = string.Empty;
    public decimal Price { get; set; }
    }

    将这个类保存在项目根目录下,命名为 Product.cs。

    5. 创建控制器处理请求

    新建控制器 ProductsController.cs:

    using Microsoft.AspNetCore.Mvc;

    [ApiController]
    [Route("api/[controller]")]
    public class ProductsController : ControllerBase
    {
    private static List _products = new List
    {
    new Product { Id = 1, Name = "键盘", Price = 299 },
    new Product { Id = 2, Name = "鼠标", Price = 99 }
    };

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

    [HttpGet("{id}")]
    public IActionResult Get(int id)
    {
    var product = _products.FirstOrDefault(p => p.Id == id);
    return product == null ? NotFound() : Ok(product);
    }

    [HttpPost]
    public IActionResult Post(Product product)
    {
    product.Id = _products.Max(p => p.Id) + 1;
    _products.Add(product);
    return CreatedAtAction(nameof(Get), new { id = product.Id }, product);
    }

    [HttpPut("{id}")]
    public IActionResult Put(int id, Product updatedProduct)
    {
    var product = _products.FirstOrDefault(p => p.Id == id);
    if (product == null) return NotFound();

    product.Name = updatedProduct.Name;
    product.Price = updatedProduct.Price;
    return NoContent();
    }

    [HttpDelete("{id}")]
    public IActionResult Delete(int id)
    {
    var product = _products.FirstOrDefault(p => p.Id == id);
    if (product == null) return NotFound();

    _products.Remove(product);
    return NoContent();
    }
    }

    这个控制器实现了标准的 CRUD 操作:

    • GET /api/products → 获取所有产品
    • GET /api/products/1 → 获取特定产品
    • POST /api/products → 添加新产品
    • PUT /api/products/1 → 更新产品
    • DELETE /api/products/1 → 删除产品

    6. 测试你的 API

    启动服务:

    dotnet run

    使用工具测试 API:

    • 浏览器访问 https://localhost:5001/api/products
    • 使用 Postman 或 curl 发送 POST、PUT、DELETE 请求
    • VS Code 安装 Thunder Client 插件进行测试

    7. 添加数据库支持(可选)

    若需要持久化存储,可集成 Entity Framework Core:

    dotnet add package Microsoft.EntityFrameworkCore.SqlServer
    dotnet add package Microsoft.EntityFrameworkCore.Tools

    然后定义 DbContext:

    public class AppDbContext : DbContext
    {
    public DbSet Products { get; set; }

    protected override void OnConfiguring(DbContextOptionsBuilder options)
    => options.UseSqlServer("Server=(localdb)\\mssqllocaldb;Database=MyAppDb;Trusted_Connection=true;");
    }

    再在 Program.cs 中注册上下文:

    builder.Services.AddDbContext();

    8. 启用 Swagger 文档

    ASP.NET Core 模板默认已集成 Swagger(也叫 OpenAPI)。运行项目后访问:

    https://localhost:5001/swagger

    你可以在浏览器中查看和测试所有 API 接口。

    9. 部署 API

    发布项目到生产环境:

    dotnet publish -c Release -o ./publish

    然后将 publish 文件夹部署到 IIS、Docker、Azure 或 Linux 服务器上。

    基本上就这些。你现在拥有了一个功能完整的 C# RESTful API,支持标准 HTTP 方法、JSON 数据交换,并具备扩展能力。后续可以加入身份验证(JWT)、日志记录、异常处理、CORS 配置等高级功能。

    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
    作者最新文章
    编程开发 C#
    相关文章 更多
    winforms教程自学入门与基础开发步骤详解
    winforms教程自学入门与基础开发步骤详解

    本教程详细讲解如何使用Visual Studio创建WinForms项目,通过添加按钮和标签控件并编写点击事件代码,实现一个基础的计数器功能,适合C#初学者快速上手Windows窗体应用开发。

    谈编程与编程语言
    谈编程与编程语言

    编程的本质是创造性的严谨翻译,通过for、if和函数调用实现重复计算任务。语言发展让集成度提高,门槛降低但竞争加剧。程序员需培养整体架构能力,抓住思想精髓而非追逐新技术,方能长远发展。

    什么是面向接口编程、面向过程编程、面向对象编程?
    什么是面向接口编程、面向过程编程、面向对象编程?

    面向接口编程通过接口解耦,降低耦合度并提升可扩展性和维护性,是面向对象思想的精髓。面向过程编程将问题拆解为步骤,用函数依次执行。面向对象编程将事物抽象为对象,封装属性和方法,通过对象协作解决问题。

    我对编程的一些感悟
    我对编程的一些感悟

    编程这件事,说到底是门手艺活,但又不全是手艺。把代码写出来容易,把代码写好、写出境界,那就得看功夫了。今天聊几个核心判断,算是多年敲键盘的一点沉淀。 一、语言是功夫,思路是内功 编程语言五花八门,就像武林高手会的功夫一样,但想成为顶尖高手,内功必须深厚。内功到了,学新功夫就是分分钟的事。看过《倚天屠

    c#如何使用abstract类_c#abstract类看这一篇就够了_保姆级教程
    c#如何使用abstract类_c#abstract类看这一篇就够了_保姆级教程

    abstract类不能被直接实例化,子类必须用override实现其所有抽象方法。抽象类可实现接口,并以抽象方法转发接口成员。抽象类不能与sealed共用,其抽象方法默认隐式virtual且无方法体。可包含字段、属性等非抽象成员。

    c#如何删除文件_c#删除文件的正确用法与注意事项
    c#如何删除文件_c#删除文件的正确用法与注意事项

    C#删除文件前应先判断存在性以防异常,注意权限不足和文件被占用。File.Delete与FileInfo.Delete功能相同,后者适合多次操作。无异步删除方法,推荐后台执行或限流以避免阻塞。

    c#如何使用EmguCV_c#EmguCV的最佳实践与常见坑点
    c#如何使用EmguCV_c#EmguCV的最佳实践与常见坑点

    在EmguCV中,进行Bitmap转Image时,需先转为24位无Alpha格式,以避免颜色错乱问题;Image转Bitmap时,建议使用Mat或ImageBox控件,以有效减少内存拷贝;跨线程处理时,应使用Mat.Clone()进行深拷贝,以确保数据安全;DLL加载失败时,需设置x64平台目标,并确保native库在输出目录中。

    C#怎么实现图表生成 C#如何用LiveCharts和OxyPlot绘制柱状图折线图饼图【图表】
    C#怎么实现图表生成 C#如何用LiveCharts和OxyPlot绘制柱状图折线图饼图【图表】

    C#图表生成中,LiveCharts需用ChartValues数据集合,并在更新后触发重绘;OxyPlot饼图需启用交互与标签;包引用务必注意版本适配;导出图片需在布局完成后操作,并校正DPI缩放以确保清晰度。

    C#怎么实现过滤器Filter_C# ASP.NET Core过滤器详解教程【进阶】
    C#怎么实现过滤器Filter_C# ASP.NET Core过滤器详解教程【进阶】

    ASP.NETCore过滤器需关注执行顺序、作用域与DI生命周期。接口实现需手动注册,特性继承更常用但需满足构造函数要求。全局注册时注意scoped服务注入问题,Order值须显式设置以控制同类型过滤器执行顺序。异常过滤器仅捕获操作方法内异常,模型绑定与授权失败须分别处理。

    c#如何实现鼠标钩子_c#鼠标钩子完整教程与实战案例
    c#如何实现鼠标钩子_c#鼠标钩子完整教程与实战案例

    实现全局鼠标钩子需使用SetWindowsHookEx配合WH_MOUSE_LL,窗体级事件仅捕获本进程消息。回调函数必须为静态且标记特定签名,禁止阻塞操作。通过Marshal.PtrToStructure解析lParam获取坐标与按键状态。钩子生命周期绑定线程,需注意注册线程持续运行并双重卸载,避免句柄泄漏。

    查看更多
    精品专题 更多
    装机必备
    装机必备

    正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

    Windows
    Windows

    正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

    PDF教程
    PDF教程

    正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

    Mac软件 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    Aperty macOS版
    Aperty macOS版
    macOS

    Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

    WINDOWS 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    PixTV 网页版
    PixTV 网页版
    Windows

    PixTV 是一款在浏览器中使用的 AI 视觉内容创作平台,提供图片、视频、音频、文字生成、AI 分镜、局部重绘、提示词反推和无限画布等工具,适合短剧、漫剧、广告及社交媒体内容制作。