.NET 5 Web API 获取本地 JSON 文件数据教程

.NET 5 Web API 获取本地 JSON 文件数据教程

本教程将引导您如何在 .NET 5 的 Web API 项目中获取本地 JSON 文件的数据。

步骤：

1. 创建文件夹和 JSON 文件

   在 Web API 项目的根目录下创建一个名为 'Data' 的文件夹，并将要使用的 JSON 文件放入该文件夹中。假设 JSON 文件名为 'data.json'。

2. 创建控制器

   创建一个名为 'DataController' 的控制器，用于获取 JSON 文件的数据。以下是一个示例代码：

   using Microsoft.AspNetCore.Mvc;
   using System.IO;
   
   namespace YourNamespace.Controllers
   {
       [Route("api/[controller]")]
       [ApiController]
       public class DataController : ControllerBase
       {
           [HttpGet]
           public IActionResult GetData()
           {
               string jsonFilePath = Path.Combine(Directory.GetCurrentDirectory(), "Data", "data.json");
   
               if (System.IO.File.Exists(jsonFilePath))
               {
                   string jsonData = System.IO.File.ReadAllText(jsonFilePath);
                   return Ok(jsonData);
               }
               else
               {
                   return NotFound();
               }
           }
       }
   }
   

3. 添加路由配置

   在 Startup.cs 文件中的 ConfigureServices 方法中添加以下代码：

   services.AddControllers();
   

4. 配置端点

   在 Configure 方法中添加以下代码：

   app.UseEndpoints(endpoints =>
   {
       endpoints.MapControllers();
   });
   

5. 启动应用程序并访问

   启动 Web API 应用程序，并访问 https://localhost:{port}/api/data（其中 {port} 是你的应用程序配置的端口号）即可获取 JSON 文件的数据。

注意：

• 上述代码示例中假设 JSON 文件的内容是字符串。如果 JSON 文件的内容是一个对象，可以使用 JsonSerializer 类将其反序列化为对象。
• 确保 JSON 文件路径正确，并且 Web API 应用程序有权限访问该文件。
• 可以根据实际情况修改代码，例如添加参数来指定要读取的 JSON 文件名。