.NET WebApi 项目必要配置项详解 | 极客日志

.NET WebApi 项目必要配置项详解 | 极客日志

{
  "ConnectionStrings": {
    "DefaultConnection": "Server=YOUR_SERVER_NAME;Database=YOUR_DATABASE_NAME;User ID=YOUR_USERNAME;Password=YOUR_PASSWORD;Trusted_Connection=False;MultipleActiveResultSets=true"
  }
}

using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.EntityFrameworkCore;

var builder = WebApplication.CreateBuilder(args);
var connectionString = builder.Configuration.GetConnectionString("DefaultConnection");
builder.Services.AddDbContext<YourDbContext>(options =>
    options.UseSqlServer(connectionString));

using Microsoft.EntityFrameworkCore;

public class YourDbContext : DbContext
{
    public YourDbContext(DbContextOptions<YourDbContext> options) : base(options)
    {
    }
    // 定义 DbSet 属性来映射数据库表
    public DbSet<YourEntity> YourEntities { get; set; }
}

builder.Services.AddLogging();

public interface IYourService
{
    void DoSomething();
}

public class YourService : IYourService
{
    public void DoSomething()
    {
        // 业务逻辑代码
    }
}

builder.Services.AddScoped<IYourService, YourService>();

using Microsoft.AspNetCore.Mvc;

[ApiController]
[Route("[controller]")]
public class YourController : ControllerBase
{
    private readonly IYourService _yourService;

    public YourController(IYourService yourService)
    {
        _yourService = yourService;
    }

    [HttpGet]
    public IActionResult Get()
    {
        _yourService.DoSomething();
        return Ok("Service executed successfully");
    }
}

using Swashbuckle.AspNetCore.SwaggerGen;
using Microsoft.OpenApi.Models;

builder.Services.AddSwaggerGen(c =>
{
    c.SwaggerDoc("v1", new OpenApiInfo
    {
        Title = "Your WebApi Title",
        Version = "v1",
        Description = "A detailed description of your WebApi",
        Contact = new OpenApiContact
        {
            Name = "Your Name",
            Email = "[email protected]",
            Url = new Uri("https://example.com")
        }
    });
    // 配置 XML 注释文件路径，用于生成详细的接口文档
    var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
    var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
    c.IncludeXmlComments(xmlPath);
});

app.UseSwagger();
app.UseSwaggerUI(c =>
{
    c.SwaggerEndpoint("/swagger/v1/swagger.json", "Your WebApi V1");
    c.RoutePrefix = "swagger"; // 设置 Swagger UI 的访问路径
});

builder.Services.AddControllers()
    .AddJsonOptions(options =>
    {
        options.JsonSerializerOptions.PropertyNameCaseInsensitive = false;
    });

builder.Services.AddControllers()
    .AddNewtonsoftJson(options =>
    {
        options.SerializerSettings.ContractResolver = new DefaultContractResolver();
    });

builder.Services.AddControllers()
    .AddJsonOptions(options =>
    {
        options.JsonSerializerOptions.PropertyNamingPolicy = JsonNamingPolicy.CamelCase;
    });

{
  "AllowedOrigins": [
    "http://localhost:3000",
    "https://example.com"
  ]
}

using Microsoft.AspNetCore.Cors.Infrastructure;

var allowedOrigins = builder.Configuration.GetSection("AllowedOrigins").Get<string[]>();
var corsBuilder = new CorsPolicyBuilder();
corsBuilder.AllowAnyHeader();
corsBuilder.AllowAnyMethod();
corsBuilder.WithOrigins(allowedOrigins);

builder.Services.AddCors(options =>
{
    options.AddPolicy("AllowSpecificOrigins", corsBuilder.Build());
});

app.UseCors("AllowSpecificOrigins");

builder.Services.AddCors(options =>
{
    options.AddPolicy("AllowAll", builder =>
    {
        builder.AllowAnyOrigin()
               .AllowAnyMethod()
               .AllowAnyHeader();
    });
});

using Microsoft.AspNetCore.Authentication.JwtBearer;
using Microsoft.IdentityModel.Tokens;
using System.Text;

var jwtSettings = builder.Configuration.GetSection("JwtSettings");
var key = Encoding.ASCII.GetBytes(jwtSettings["SecretKey"]);

builder.Services.AddAuthentication(options =>
{
    options.DefaultAuthenticateScheme = JwtBearerDefaults.AuthenticationScheme;
    options.DefaultChallengeScheme = JwtBearerDefaults.AuthenticationScheme;
})
.AddJwtBearer(options =>
{
    options.RequireHttpsMetadata = false;
    options.SaveToken = true;
    options.TokenValidationParameters = new TokenValidationParameters
    {
        ValidateIssuer = true,
        ValidateAudience = true,
        ValidateLifetime = true,
        ValidateIssuerSigningKey = true,
        ValidIssuer = jwtSettings["Issuer"],
        ValidAudience = jwtSettings["Audience"],
        IssuerSigningKey = new SymmetricSecurityKey(key)
    };
});

builder.Services.AddAuthorization();

[ApiController]
[Route("[controller]")]
[Authorize(Roles = "Admin")]
public class AdminController : ControllerBase
{
    // 只有具有 Admin 角色的用户才能访问此控制器的方法
}

builder.Services.AddAuthorization(options =>
{
    options.AddPolicy("MustBeOver21", policy =>
    policy.RequireAssertion(context =>
    {
        // 这里可以编写自定义的授权逻辑，例如检查用户年龄
        var user = context.User;
        // 假设用户声明中包含年龄信息
        var ageClaim = user.FindFirst("Age");
        if (ageClaim != null)
        {
            int age = int.Parse(ageClaim.Value);
            return age >= 21;
        }
        return false;
    }));
});

[ApiController]
[Route("[controller]")]
[Authorize(Policy = "MustBeOver21")]
public class AgeRestrictedController : ControllerBase
{
    // 只有满足 MustBeOver21 策略的用户才能访问此控制器的方法
}

using Serilog;
using Serilog.Events;

var logger = new LoggerConfiguration()
    .MinimumLevel.Override("Microsoft", LogEventLevel.Information)
    .Enrich.FromLogContext()
    .WriteTo.Console()
    .CreateLogger();

builder.Logging.ClearProviders();
builder.Logging.AddSerilog(logger);