Visual Studio2022创建WebAPI项目步骤记录

这篇文章将为大家详细讲解有关Visual Studio2022创建WebAPI项目步骤记录，小编觉得挺实用的，因此分享给大家做个参考，希望大家阅读完这篇文章后可以有所收获。

创建 Visual Studio 2022 Web API 项目的步骤

准备工作

• 安装 Visual Studio 2022
• 确保已安装 ASP.NET Core 工作负载

步骤 1：创建新项目

• 打开 Visual Studio 2022
• 单击“文件”>“新建”>“项目”
• 在搜索栏中输入“Web API”，然后从结果列表中选择“ASP.NET Core Web API”模板
• 输入项目名称，选择保存位置，然后单击“创建”

步骤 2：选择模板

• 从模板选项中，选择“Empty”模板。
• 选中“启用 Swagger/OpenAPI 文档”复选框。

步骤 3：配置项目

• 在“解决方案资源管理器”中，右键单击项目并选择“属性”
• 在“应用程序”选项卡上，配置项目目标框架。
• 在“调试”选项卡上，选择要启动项目的 Web 服务器。

步骤 4：添加控制器

• 右键单击“控制器”文件夹并选择“添加”>“新建项”
• 选择“Web API 控制器类”，输入控制器名称，然后单击“添加”

步骤 5：设置路由

• 在 Startup.cs 文件中，在 ConfigureServices 和 Configure 方法中添加必要的路由规则。

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();
    });
}

步骤 6：创建模型类

• 为项目添加一个新类，并将其命名为模型类（例如：Product）
• 定义类属性以表示模型数据。

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

步骤 7：添加数据库上下文

• 为项目添加一个新 DbContext 类（例如：MyContext）。
• 在 DbContext 类中，使用 OnModelCreating 方法来配置模型。

public class MyContext : DbContext
{
    public MyContext(DbContextOptions<MyContext> options) : base(options) { }

    public DbSet<Product> Products { get; set; }

    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        modelBuilder.Entity<Product>(entity =>
        {
            entity.Property(p => p.Name).HasMaxLength(255);
            entity.Property(p => p.Price).HasPrecision(18, 2);
        });
    }
}

步骤 8：添加存储库接口

• 为项目添加一个接口，该接口定义了存储库操作（例如：IProductRepository）
• 定义接口方法以进行 CRUD（创建、读取、更新、删除）操作。

public interface IProductRepository
{
    Task<Product> GetByIdAsync(int id);
    Task<IEnumerable<Product>> GetAllAsync();
    Task<Product> AddAsync(Product product);
    Task UpdateAsync(Product product);
    Task DeleteAsync(int id);
}

步骤 9：添加存储库实现

• 为项目添加存储库实现（例如：ProductRepository）。
• 在实现中，使用 DbContext 执行数据库查询。

public class ProductRepository : IProductRepository
{
    private readonly MyContext _context;

    public ProductRepository(MyContext context)
    {
        _context = context;
    }

    public async Task<Product> GetByIdAsync(int id)
    {
        return await _context.Products.FindAsync(id);
    }

    public async Task<IEnumerable<Product>> GetAllAsync()
    {
        return await _context.Products.ToListAsync();
    }

    public async Task<Product> AddAsync(Product product)
    {
        _context.Products.Add(product);
        await _context.SaveChangesAsync();
        return product;
    }

    public async Task UpdateAsync(Product product)
    {
        _context.Entry(product).State = EntityState.Modified;
        await _context.SaveChangesAsync();
    }

    public async Task DeleteAsync(int id)
    {
        var product = await _context.Products.FindAsync(id);
        if (product != null)
        {
            _context.Products.Remove(product);
            await _context.SaveChangesAsync();
        }
    }
}

步骤 10：添加服务

• 在 Startup.cs 文件中，在 ConfigureServices 方法中添加服务。
• 将存储库实现注册为服务。

public void ConfigureServices(IServiceCollection services)
{
    services.AddControllers();
    services.AddDbContext<MyContext>(options => options.UseInMemoryDatabase("MyDb"));
    services.AddScoped<IProductRepository, ProductRepository>();
}

步骤 11：添加控制器动作

• 在控制器中，添加动作方法以实现所需功能（例如：获取产品列表）。
• 在动作中，使用存储库方法检索数据。

[HttpGet]
public async Task<IActionResult> GetProductsAsync()
{
    var products = await _productRepository.GetAllAsync();
    return Ok(products);
}

步骤 12：运行项目

• 按 F5 启动项目
• 确保 Web 服务器正在运行
• 在浏览器中访问项目 URL 以测试 API

以上就是Visual Studio2022创建WebAPI项目步骤记录的详细内容，更多请关注编程学习网其它相关文章！