当前位置：首页 > 行业动态 > 正文

c webapi教程

admin
行业动态
2025-02-16
3

C# Web API 教程旨在帮助开发者使用 C# 语言构建和开发 Web API，以下是一份详细的指南，涵盖从基础概念到实际开发的各个方面：

一、Web API 基础概念

1、什么是 Web API：Web API 是一种基于 HTTP 协议的应用程序编程接口，它允许不同的客户端（如浏览器、移动设备等）与服务器进行通信和数据交换，在 C# 中，ASP.NET Web API 是一个常用的框架，用于构建这些服务。

2、为什么使用 Web API：Web API 提供了一种标准化的方式来构建面向各种客户端的服务，使得不同平台之间的数据交互更加便捷和高效，它可以支持多种数据格式（如 JSON、XML 等），并且具有良好的可扩展性和可维护性。

二、开发环境搭建

1、安装 Visual Studio：下载并安装 Visual Studio 2019 或更高版本，在安装过程中，确保选择 “ASP.NET and web development” 工作负载，以便安装相关的开发工具和组件。

2、创建项目：打开 Visual Studio，选择 “File” -> “New” -> “Project”，然后选择 “ASP.NET Core Web API” 项目模板，配置项目名称、位置等信息后，点击 “Create” 按钮创建项目。

三、项目结构与文件

1、Controllers 文件夹：用于存放控制器类，控制器负责处理客户端的请求，并返回相应的响应，每个控制器通常继承自ApiController 基类。

2、Models 文件夹：包含模型类，模型类用于定义数据的结构和格式，通常与数据库中的表或视图相对应。

3、appsettings.json 文件：用于存储应用程序的配置信息，如数据库连接字符串、API 密钥等。

4、Startup.cs 文件：是应用程序的启动类，用于配置服务、中间件管道等，在ConfigureServices 方法中可以注册服务，在Configure 方法中可以配置中间件。

四、创建简单的 Web API

1、定义模型类：在 Models 文件夹中创建一个名为Contact.cs 的类，用于表示联系人的信息。

 public class Contact
   {
       public int ID { get; set; }
       public string Name { get; set; }
       public int Age { get; set; }
       public DateTime Birthday { get; set; }
       public string Sex { get; set; }
   }

2、创建控制器类：在 Controllers 文件夹中创建一个名为ContactController.cs 的控制器类，继承自ApiController，在控制器中定义一些基本的操作方法，如获取所有联系人、根据 ID 获取联系人、添加联系人等。

 [ApiController]
   [Route("api/[controller]")]
   public class ContactController : ControllerBase
   {
       private static readonly List<Contact> contacts = new List<Contact>
       {
           new Contact { ID = 1, Name = "嗷叫", Age = 20, Birthday = new DateTime(1988, 7, 25), Sex = "男" },
           new Contact { ID = 2, Name = "阿拉斯", Age = 18, Birthday = new DateTime(1988, 7, 3), Sex = "女" },
           new Contact { ID = 3, Name = "网袜", Age = 1, Birthday = new DateTime(1988, 7, 26), Sex = "女" },
           new Contact { ID = 4, Name = "哈子", Age = 4, Birthday = new DateTime(1988, 7, 5), Sex = "男" }
       };
       [HttpGet]
       public IEnumerable<Contact> GetListAll()
       {
           return contacts;
       }
       [HttpGet("{id}")]
       public Contact GetContactByID(int id)
       {
           var contact = contacts.FirstOrDefault(c => c.ID == id);
           if (contact == null)
           {
               throw new HttpResponseException(HttpStatusCode.NotFound);
           }
           return contact;
       }
       [HttpPost]
       public void PostContact([FromBody] Contact contact)
       {
           contacts.Add(contact);
       }
   }

3、运行项目：按下 “Ctrl + F5” 键运行项目，Visual Studio 会启动一个本地的开发服务器，并在浏览器中打开默认的页面，此时可以通过访问http://localhost:port/api/contact 来测试 API，其中port 是随机分配的端口号。

五、常见问题解答

1、问题：如何在 Web API 中实现身份验证和授权？

回答：可以使用多种方式来实现身份验证和授权，如 JWT（JSON Web Token）、OAuth 等，以 JWT 为例，需要在用户登录成功后生成一个 token，并将其返回给客户端，客户端在后续的请求中需要在请求头中携带该 token，服务器端则通过中间件来验证 token 的有效性，具体的实现代码可以参考相关的文档和教程。

2、问题：如何处理 Web API 中的异常？

回答：可以使用全局异常处理机制来捕获和处理应用程序中的异常，在 ASP.NET Core 中，可以通过实现IExceptionFilter 接口来创建自定义的异常过滤器，并在Startup.cs 文件中将其添加到管道中，在异常过滤器中，可以将异常转换为合适的 HTTP 状态码和错误消息，然后返回给客户端。