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

c# web api教程实例子

admin
行业动态
2025-03-01
7

“

csharp，using System.Collections.Generic;，using System.Web.Http;namespace WebApiExample.Controllers，{， public class ValuesController : ApiController， {， // GET api/values， public IEnumerable Get()， {， return new string[] { "value1", "value2" };， }， }，}，

` 在这个示例中，我们创建了一个名为ValuesController 的API控制器，并在其中定义了一个Get 方法。当客户端发送一个GET请求到/api/values`时，这个方法将返回一个字符串数组，包含两个值：”value1″和”value2″。

C# Web API 教程实例子

一、创建简单的 Web API 项目

创建项目

打开 Visual Studio，选择“创建新项目”，在项目模板中选择“ASP.NET Core Web API”项目模板，然后点击“下一步”，配置项目名称、保存位置等信息后，点击“创建”。

定义模型

在 Models 文件夹下创建一个 Product.cs 文件，定义产品模型类：

namespace WebAPIExample.Models
{
    public class Product
    {
        public int Id { get; set; }
        public string Name { get; set; }
        public decimal Price { get; set; }
        public string Category { get; set; }
    }
}

创建控制器

在 Controllers 文件夹下创建一个 ProductsController.cs 文件，定义产品控制器类：

using Microsoft.AspNetCore.Mvc;
using WebAPIExample.Models;
using System.Collections.Generic;
using System.Linq;
namespace WebAPIExample.Controllers
{
    [Route("api/[controller]")]
    [ApiController]
    public class ProductsController : ControllerBase
    {
        private static List<Product> products = new List<Product>
        {
            new Product { Id = 1, Name = "Laptop", Price = 999.99m, Category = "Electronics" },
            new Product { Id = 2, Name = "Smartphone", Price = 499.99m, Category = "Electronics" },
            new Product { Id = 3, Name = "Coffee Maker", Price = 29.99m, Category = "Home Appliances" }
        };
        // GET: api/products
        [HttpGet]
        public ActionResult<IEnumerable<Product>> GetAllProducts()
        {
            return products;
        }
        // GET: api/products/5
        [HttpGet("{id}")]
        public ActionResult<Product> GetProduct(int id)
        {
            var product = products.FirstOrDefault(p => p.Id == id);
            if (product == null)
            {
                return NotFound();
            }
            return product;
        }
        // POST: api/products
        [HttpPost]
        public void CreateProduct([FromBody] Product product)
        {
            products.Add(product);
        }
        // PUT: api/products/5
        [HttpPut("{id}")]
        public void UpdateProduct(int id, [FromBody] Product product)
        {
            var existingProduct = products.FirstOrDefault(p => p.Id == id);
            if (existingProduct != null)
            {
                existingProduct.Name = product.Name;
                existingProduct.Price = product.Price;
                existingProduct.Category = product.Category;
            }
        }
        // DELETE: api/products/5
        [HttpDelete("{id}")]
        public void DeleteProduct(int id)
        {
            var product = products.FirstOrDefault(p => p.Id == id);
            if (product != null)
            {
                products.Remove(product);
            }
        }
    }
}

运行项目

按 F5 键运行项目，Web API 项目将启动并监听默认的端口（通常是 5000 或 5001），可以在浏览器中访问 http://localhost:5000/api/products 来测试 API。

请求类型	请求 URL	说明
GET	http://localhost:5000/api/products	获取所有产品列表
GET	http://localhost:5000/api/products/{id}	根据 ID 获取单个产品
POST	http://localhost:5000/api/products	创建新产品
PUT	http://localhost:5000/api/products/{id}	更新产品信息
DELETE	http://localhost:5000/api/products/{id}	删除产品

二、使用 Swagger 进行文档生成和测试

安装 Swagger 组件

在 NuGet 包管理器控制台中执行以下命令，安装 Swashbuckle.AspNetCore 包：

c# web api教程实例子

Install-Package Swashbuckle.AspNetCore -Version 6.2.3

配置 Swagger

在 Startup.cs 文件中的 ConfigureServices 方法中添加 Swagger 服务配置：

public void ConfigureServices(IServiceCollection services)
{
    services.AddControllers();
    services.AddSwaggerGen(c =>
    {
        c.SwaggerDoc("v1", new OpenApiInfo { Title = "WebAPIExample", Version = "v1" });
    });
}

在 Configure 方法中使用 app.UseSwagger() 和 app.UseSwaggerUI() 中间件：

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }
    app.UseRouting();
    app.UseEndpoints(endpoints => { endpoints.MapControllers(); });
    app.UseSwagger();
    app.UseSwaggerUI(c => c.SwaggerEndpoint("/swagger/v1/swagger.json", "WebAPIExample v1"));
}

访问 Swagger UI

运行项目后，在浏览器中访问 http://localhost:5000/swagger/index.html，即可看到 Swagger UI 界面，通过该界面可以方便地对 API 进行测试和查看文档。

三、连接数据库实现数据持久化存储

1. 安装 Entity Framework Core 包

c# web api教程实例子

在 NuGet 包管理器控制台中执行以下命令，安装 Microsoft.EntityFrameworkCore.SqlServer 包：

Install-Package Microsoft.EntityFrameworkCore.SqlServer -Version 5.0.17

创建数据库上下文类

在 Data 文件夹下创建一个 ApplicationDbContext.cs 文件，定义数据库上下文类：

using Microsoft.EntityFrameworkCore;
using WebAPIExample.Models;
namespace WebAPIExample.Data
{
    public class ApplicationDbContext : DbContext
    {
        public ApplicationDbContext(DbContextOptions<ApplicationDbContext> options) : base(options) { }
        public DbSet<Product> Products { get; set; }
    }
}

配置数据库连接字符串

在 appsettings.json 文件中添加数据库连接字符串：

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

修改控制器以使用数据库操作

在 ProductsController.cs 文件中，修改构造函数以注入数据库上下文，并将静态列表替换为数据库操作：

using Microsoft.EntityFrameworkCore;
using System.Linq;
using System.Threading.Tasks;
namespace WebAPIExample.Controllers
{
    [Route("api/[controller]")]
    [ApiController]
    public class ProductsController : ControllerBase
    {
        private readonly ApplicationDbContext _context;
        public ProductsController(ApplicationDbContext context)
        {
            _context = context;
        }
        // GET: api/products
        [HttpGet]
        public async Task<ActionResult<IEnumerable<Product>>> GetAllProducts()
        {
            return await _context.Products.ToListAsync();
        }
        // GET: api/products/5
        [HttpGet("{id}")]
        public async Task<ActionResult<Product>> GetProduct(int id)
        {
            var product = await _context.Products.FindAsync(id);
            if (product == null)
            {
                return NotFound();
            }
            return product;
        }
        // POST: api/products
        [HttpPost]
        public async Task<ActionResult<Product>> CreateProduct([FromBody] Product product)
        {
            _context.Products.Add(product);
            await _context.SaveChangesAsync();
            return CreatedAtAction("GetProduct", new { id = product.Id }, product);
        }
        // PUT: api/products/5
        [HttpPut("{id}")]
        public async Task<IActionResult> UpdateProduct(int id, [FromBody] Product product)
        {
            if (id != product.Id)
            {
                return BadRequest();
            }
            var existingProduct = await _context.Products.FindAsync(id);
            if (existingProduct != null)
            {
                existingProduct.Name = product.Name;
                existingProduct.Price = product.Price;
                existingProduct.Category = product.Category;
            }
            else
            {
                return NotFound();
            }
            await _context.SaveChangesAsync();
            return NoContent();
        }
        // DELETE: api/products/5
        [HttpDelete("{id}")]
        public async Task<IActionResult> DeleteProduct(int id)
        {
            var product = await _context.Products.FindAsync(id);
            if (product == null)
            {
                return NotFound();
            }
            _context.Products.Remove(product);
            await _context.SaveChangesAsync();
            return NoContent();
        }
    }
}

迁移数据库并初始化数据

在 NuGet 包管理器控制台中执行以下命令，安装 Microsoft.EntityFrameworkCore.Tools 包：

c# web api教程实例子

Install-Package Microsoft.EntityFrameworkCore.Tools -Version 5.0.17

在 Package Manager 控制台窗口中执行以下命令，迁移数据库并初始化数据：

Add-Migration InitialCreate
Update-Database

四、实现用户认证和授权（JWT）

安装 JWT 相关包

在 NuGet 包管理器控制台中执行以下命令，安装 Microsoft.IdentityModel.Tokens、System.IdentityModel.Tokens.Jwt 和 Swashbuckle.AspNetCore.SwaggerGen 包：

Install-Package Microsoft.IdentityModel.Tokens -Version 6.21.0
Install-Package System.IdentityModel.Tokens.Jwt -Version 6.21.0
Install-Package Swashbuckle.AspNetCore.SwaggerGen -Version 6.2.3

创建用户模型和服务类

在 Models 文件夹下创建一个 User.cs 文件，定义用户模型类：

namespace WebAPIExample.Models
{
    public class User
    {
        public int Id { get; set; }
        public string Username { get; set; }
        public string Password { get; set; } // 注意：实际应用中不应明文存储密码，应进行加密处理，这里为了简化示例直接存储明文密码。
    }
}

在 Services 文件夹下创建一个 UserService.cs 文件，定义用户服务类：

using Microsoft.Extensions.Configuration;
using System;
using System.Collections.Generic;
using System.Security.Claims;
using System.Text;
using System.IdentityModel.Tokens.Jwt;
using Microsoft.IdentityModel.Tokens;
using WebAPIExample.Models;
using System.Linq;
namespace WebAPIExample.Services
{
    public class UserService : IUserService
    {
        private readonly List<User> users = new List<User> { new User { Id = 1, Username = "admin", Password = "admin123" } }; // 示例用户数据，实际应用中应从数据库读取。
private readonly IConfiguration configuration;
        public UserService(IConfiguration config) => configuration = config;
        public User Authenticate(string username, string password) { var user = users.SingleOrDefault(u => u.Username == username && u.Password == password); return user; } } } } public string GenerateToken(User user) { var tokenHandler = new JwtSecurityTokenHandler(); var key = Encoding.ASCII.GetBytes(configuration["Jwt:Key"]); var tokenDescriptor = new SecurityTokenDescriptor { Subject = new ClaimsIdentity(new[] { new Claim("id", user.Id.ToString()), new Claim(ClaimTypes.Name, user.Username) }), Expires = DateTime.UtcNow.AddHours(1), SigningCredentials = new SigningCredentials(new SymmetricSecurityKey(key), SecurityAlgorithms.HmacSha256Signature) }; var token = tokenHandler.CreateToken(tokenDescriptor); return tokenHandler.WriteToken(token); } } } } } } }