c# .netcore Web API如何设计 - 问答

设计一个C# .NET Core Web API需要考虑多个方面，包括路由、控制器、模型、数据访问、身份验证和授权等。以下是一个基本的步骤指南，帮助你设计一个简单的Web API。

1. 创建项目

首先，使用Visual Studio或命令行工具创建一个新的.NET Core Web API项目。

dotnet new webapi -n MyApiApp
cd MyApiApp

2. 配置路由

在Startup.cs文件中配置路由。默认情况下，Web API会提供一个默认的路由来处理所有的请求。

public void ConfigureServices(IServiceCollection services)
{
    services.AddControllers();
}

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }

    app.UseRouting();

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

3. 创建控制器

创建一个控制器来处理HTTP请求。例如，创建一个UsersController。

dotnet new controller -n UsersController

在UsersController.cs中添加基本的CRUD操作。

using Microsoft.AspNetCore.Mvc;
using System.Collections.Generic;
using System.Linq;

[ApiController]
[Route("api/[controller]")]
public class UsersController : ControllerBase
{
    private static readonly List<User> _users = new List<User>
    {
        new User { Id = 1, Name = "Alice", Email = "alice@example.com" },
        new User { Id = 2, Name = "Bob", Email = "bob@example.com" }
    };

    [HttpGet]
    public ActionResult<IEnumerable<User>> GetUsers()
    {
        return Ok(_users);
    }

    [HttpGet("{id}")]
    public ActionResult<User> GetUser(int id)
    {
        var user = _users.FirstOrDefault(u => u.Id == id);
        if (user == null)
        {
            return NotFound();
        }
        return Ok(user);
    }

    [HttpPost]
    public ActionResult<User> PostUser(User user)
    {
        _users.Add(user);
        return CreatedAtAction(nameof(GetUser), new { id = user.Id }, user);
    }

    [HttpPut("{id}")]
    public IActionResult PutUser(int id, User user)
    {
        if (id != user.Id)
        {
            return BadRequest();
        }
        var index = _users.IndexOf(user);
        if (index < 0)
        {
            return NotFound();
        }
        _users[index] = user;
        return NoContent();
    }

    [HttpDelete("{id}")]
    public IActionResult DeleteUser(int id)
    {
        var user = _users.FirstOrDefault(u => u.Id == id);
        if (user == null)
        {
            return NotFound();
        }
        _users.Remove(user);
        return NoContent();
    }
}

4. 定义模型

定义一个User类来表示用户数据。

public class User
{
    public int Id { get; set; }
    public string Name { get; set; }
    public string Email { get; set; }
}

5. 运行和测试API

运行你的Web API项目，并使用工具如Postman或curl来测试API端点。

dotnet run

使用Postman：

GET /api/users - 获取所有用户
GET /api/users/1 - 获取ID为1的用户
POST /api/users - 创建一个新用户
PUT /api/users/1 - 更新ID为1的用户
DELETE /api/users/1 - 删除ID为1的用户

6. 添加身份验证和授权

为了添加身份验证和授权，你可以使用ASP.NET Core Identity或其他身份验证库。以下是一个简单的示例，使用ASP.NET Core Identity。

安装依赖

dotnet add package Microsoft.AspNetCore.Identity.EntityFrameworkCore
dotnet add package Microsoft.EntityFrameworkCore.SqlServer

配置Identity

在Startup.cs中配置Identity。

public void ConfigureServices(IServiceCollection services)
{
    services.AddDbContext<ApplicationDbContext>(options =>
        options.UseSqlServer(Configuration.GetConnectionString("DefaultConnection")));

    services.AddIdentity<ApplicationUser, IdentityRole>()
        .AddEntityFrameworkStores<ApplicationDbContext>()
        .AddDefaultTokenProviders();

    services.AddControllers();
}

创建数据库上下文和用户实体

创建ApplicationDbContext和ApplicationUser类。

public class ApplicationDbContext : IdentityDbContext<ApplicationUser>
{
    public ApplicationDbContext(DbContextOptions<ApplicationDbContext> options)
        : base(options)
    {
    }
}

public class ApplicationUser : IdentityUser
{
}

配置数据库连接字符串

在appsettings.json中添加数据库连接字符串。

"ConnectionStrings": {
    "DefaultConnection": "Server=(localdb)\\mssqllocaldb;Database=MyApiAppDb;Trusted_Connection=True;MultipleActiveResultSets=true"
}

运行和测试API

再次运行你的Web API项目，并使用身份验证保护端点。

dotnet run

使用Postman：

GET /api/users - 需要身份验证
POST /api/users - 需要身份验证

总结

以上是一个基本的C# .NET Core Web API设计示例。你可以根据需要扩展和修改这个示例，添加更多的功能，如数据验证、错误处理、日志记录等。

0 赞

0 踩