0

0

C#如何创建REST API C#使用ASP.NET Core构建Web API入门指南

月夜之吻

月夜之吻

发布时间:2025-11-17 16:48:06

|

519人浏览过

|

来源于php中文网

原创

使用asp.net core创建rest api最推荐。它跨平台、高性能,适合构建现代web api。通过dotnet new webapi命令可快速创建项目,默认包含weatherforecast示例并启动服务。控制器继承controllerbase,用[apicontroller]和[route]定义路由,如productscontroller实现get、post等操作。启用swagger需安装swashbuckle包,添加addswaggergen和useswagger中间件,访问/swagger可查看交互式文档。建议结合postman测试接口,注意content-type设置为application/json。后续可集成ef core、身份验证等功能,逐步扩展功能。掌握基础后多练习小项目,关注路由、状态码与异常处理细节。

c#如何创建rest api c#使用asp.net core构建web api入门指南

要用C#创建REST API,最推荐的方式是使用ASP.NET Core。它是一个跨平台、高性能的框架,专为构建现代Web API而设计。下面是一份简明实用的入门指南,帮助你快速搭建一个基础的REST API。

创建ASP.NET Core Web API项目

打开命令行工具或Visual Studio,运行以下命令创建一个新的Web API项目:

dotnet new webapi -n MyFirstApi cd MyFirstApi dotnet run

执行后,项目会启动,默认在https://localhost:5001提供服务,并包含一个自动生成的WeatherForecast示例API。

理解控制器与路由

ASP.NET Core使用控制器来处理HTTP请求。每个控制器是一个继承自 ControllerBase 的类,通常放在Controllers文件夹中。

例如,创建一个管理“产品”的API:

// Controllers/ProductsController.cs using Microsoft.AspNetCore.Mvc;

[ApiController]
[Route("api/[controller]")]
public class ProductsController : ControllerBase
{
private static List products = new() { "苹果", "香蕉" };

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

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

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

}

[ApiController]启用自动模型验证和JSON绑定。
[Route]定义基础路径,[controller]会被控制器名称代替(如Products → /api/products)。

测试你的API

启动项目后,可通过以下方式测试:

Android 开发者指南 第一部分:入门
Android 开发者指南 第一部分:入门

Android文档-开发者指南-第一部分:入门-中英文对照版 Android提供了丰富的应用程序框架,它允许您在Java语言环境中构建移动设备的创新应用程序和游戏。在左侧导航中列出的文档提供了有关如何使用Android的各种API来构建应用程序的详细信息。第一部分:Introduction(入门) 0、Introduction to Android(引进到Android) 1、Application Fundamentals(应用程序基础) 2、Device Compatibility(设备兼容性) 3、

下载
  • GET /api/products:获取所有产品列表
  • GET /api/products/0:获取第一个产品
  • POST /api/products:请求体传入字符串,添加新产品

建议使用Postman、curl浏览器开发者工具发送请求。确保POST请求的Content-Type为application/json,例如:

curl -X POST https://localhost:5001/api/products \ -H "Content-Type: application/json" \ -d "\"橙子\""

启用Swagger文档(推荐)

Swagger(在ASP.NET Core中称为OpenAPI)能自动生成API文档并提供测试界面。

安装Swashbuckle:

dotnet add package Swashbuckle.AspNetCore

Program.cs中添加服务和中间件:

builder.Services.AddEndpointsApiExplorer(); builder.Services.AddSwaggerGen();

然后在app.Run()前加入:

app.UseSwagger(); app.UseSwaggerUI();

重启后访问https://localhost:5001/swagger即可看到交互式文档页面。

基本上就这些。掌握这些基础后,你可以逐步添加数据库支持(如Entity Framework Core)、身份验证、日志记录等功能。ASP.NET Core结构清晰,扩展性强,非常适合构建稳定高效的REST API。不复杂但容易忽略细节,比如路由匹配、状态码返回和异常处理,建议多写几个小接口练手。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
什么是中间件
什么是中间件

中间件是一种软件组件,充当不兼容组件之间的桥梁,提供额外服务,例如集成异构系统、提供常用服务、提高应用程序性能,以及简化应用程序开发。想了解更多中间件的相关内容,可以阅读本专题下面的文章。

182

2024.05.11

Golang 中间件开发与微服务架构
Golang 中间件开发与微服务架构

本专题系统讲解 Golang 在微服务架构中的中间件开发,包括日志处理、限流与熔断、认证与授权、服务监控、API 网关设计等常见中间件功能的实现。通过实战项目,帮助开发者理解如何使用 Go 编写高效、可扩展的中间件组件,并在微服务环境中进行灵活部署与管理。

226

2025.12.18

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

455

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

546

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

334

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

82

2025.09.10

软件测试常用工具
软件测试常用工具

软件测试常用工具有Selenium、JUnit、Appium、JMeter、LoadRunner、Postman、TestNG、LoadUI、SoapUI、Cucumber和Robot Framework等等。测试人员可以根据具体的测试需求和技术栈选择适合的工具,提高测试效率和准确性 。

463

2023.10.13

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

1010

2023.08.02

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

76

2026.03.11

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Go语言实战之 GraphQL
Go语言实战之 GraphQL

共10课时 | 0.9万人学习

微信小程序开发之API篇
微信小程序开发之API篇

共15课时 | 1.3万人学习

Laravel---API接口
Laravel---API接口

共7课时 | 0.7万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号