Cách làm chủ API Web .NET 8: Từ thiết lập đến bảo mật - 50 mẹo hay nhất

Từ thiết lập dự án ban đầu bằng .NET CLI cho đến định cấu hình phần mềm trung gian, bộ điều khiển và dịch vụ, hãy tìm hiểu từng bước để xây dựng một API mạnh mẽ. Khám phá các phương pháp hay nhất để chèn phần phụ thuộc, hành động không đồng bộ và xử lý các trường hợp ngoại lệ để tạo các ứng dụng web hiệu quả, có thể mở rộng. 1. Thiết lập dự án API Web .NET 8 Ý tưởng Sử dụng .NET CLI để tạo dự án API Web mới. Điều này thiết lập cấu trúc dự án cơ bản bao gồm Program.cs để khởi động và bộ điều khiển WeatherForecast làm ví dụ. Ví dụ về mã dotnet new webapi -n MyWebApi 2. Program.cs - Cấu hình API tối thiểu Ý tưởng .NET 8 tiếp tục xu hướng hướng tới các API tối thiểu, cho phép bạn định cấu hình các dịch vụ và điểm cuối một cách đơn giản và ngắn gọn trực tiếp trong tệp Program.cs. Ví dụ về mã var builder = WebApplication.CreateBuilder(args); var app = builder.Build(); app.MapGet("/", () => "Hello, World!"); app.Run(); 3. Xác định bộ điều khiển Ý tưởng Bộ điều khiển xử lý các yêu cầu HTTP đến và phản hồi lại máy khách. Chúng được xác định bằng cách kế thừa từ ControllerBase và chú thích bằng [ApiController]. Ví dụ về mã [ApiController] [Route("[controller]")] public class MyController : ControllerBase { [HttpGet] public IActionResult Get() => Ok("Hello from MyController"); } 4. Chèn phụ thuộc vào bộ điều khiển Ý tưởng Tính năng tiêm phụ thuộc (DI) tích hợp của .NET Core giúp dễ dàng quản lý các phần phụ thuộc. Bạn có thể đưa các dịch vụ vào bộ điều khiển của mình thông qua hàm tạo của chúng. Ví dụ về mã public class MyService { public string GetMessage() => "Injected message"; } public class MyController : ControllerBase { private readonly MyService _myService; public MyController(MyService myService) { _myService = myService; } [HttpGet] public IActionResult Get() => Ok(_myService.GetMessage()); } 5. Cấu hình dịch vụ Ý tưởng Các dịch vụ (như ngữ cảnh cơ sở dữ liệu, dịch vụ tùy chỉnh, v.v.) được định cấu hình trong tệp Program.cs, giúp chúng sẵn sàng để chèn phần phụ thuộc trong toàn bộ ứng dụng của bạn. Ví dụ về mã builder.Services.AddScoped (); 6. Cấu hình dựa trên môi trường Ý tưởng .NET hỗ trợ các tệp cấu hình dành riêng cho môi trường (appsettings.json, appsinstall.Development.json, v.v.), cho phép thực hiện các cài đặt khác nhau dựa trên môi trường của ứng dụng. Ví dụ về mã // appsettings.Development.json { "Logging": { "LogLevel": { "Default": "Debug" } } } 7. Phần mềm trung gian Ý tưởng Các thành phần phần mềm trung gian tạo thành một đường ống xử lý các yêu cầu và phản hồi. Phần mềm trung gian tùy chỉnh có thể được tạo cho các mối quan tâm xuyên suốt như ghi nhật ký hoặc xử lý lỗi. Ví dụ về mã app.Use(async (context, next) => { // Custom logic before passing to the next middleware await next(); // Custom logic after executing the next middleware }); 8. Định tuyến Ý tưởng Định tuyến trong .NET Web API đạt được thông qua định tuyến thuộc tính trên bộ điều khiển và phương thức hành động. Điều này cho phép các URL được ánh xạ trực tiếp tới các hành động của bộ điều khiển. Ví dụ về mã [HttpGet("myaction/{id}")] public IActionResult GetAction(int id) => Ok($"Action with ID = {id}"); 9. Ràng buộc mô hình Ý tưởng Liên kết mô hình tự động ánh xạ dữ liệu từ các yêu cầu HTTP tới các tham số phương thức hành động. Nó hỗ trợ các loại phức tạp, bao gồm nội dung JSON và tham số chuỗi truy vấn. Ví dụ về mã public class MyModel { public int Id { get; set; } public string Name { get; set; } } [HttpPost] public IActionResult PostAction([FromBody] MyModel model) => Ok(model); 10. Xác thực dữ liệu Ý tưởng Chú thích dữ liệu có thể được sử dụng để xác thực dữ liệu mô hình. Thuộc tính [ApiController] tự động thực thi xác thực, phản hồi bằng 400 nếu mô hình không hợp lệ. Ví dụ về mã public class MyModel { [Required] public int Id { get; set; } [StringLength(100)] public string Name { get; set; } } 11. Hành động không đồng bộ Ý tưởng Các hành động không đồng bộ cải thiện khả năng mở rộng bằng cách giải phóng các luồng trong khi chờ các thao tác I/O hoàn tất. Sử dụng từ khóa async và trả về Tác vụ hoặc Tác vụ . Ví dụ về mã [HttpGet("{id}")] public async Task GetAsync(int id) { var result = await _service.GetByIdAsync(id); return Ok(result); } 12. Xử lý ngoại lệ trên toàn cầu Ý tưởng Xử lý ngoại lệ toàn cầu cho phép xử lý lỗi tập trung, ghi nhật ký và phản hồi API được tiêu chuẩn hóa đối với các ngoại lệ chưa được xử lý. Ví dụ về mã app.UseExceptionHandler(a => a.Run(async context => { var exceptionHandlerPathFeature = context.Features.Get (); var exception = exceptionHandlerPathFeature.Error; // Log the exception, generate a custom response, etc. context.Response.StatusCode = 500; await context.Response.WriteAsJsonAsync(new { Error = "An unexpected error occurred" }); })); 13. Phiên bản API Ý tưởng Lập phiên bản API giúp quản lý các thay đổi đối với API theo thời gian. Nền tảng .NET hỗ trợ tạo phiên bản thông qua chuỗi truy vấn, đường dẫn URL hoặc tiêu đề yêu cầu. Ví dụ về mã builder.Services.AddApiVersioning(options => { options.AssumeDefaultVersionWhenUnspecified = true; options.DefaultApiVersion = new ApiVersion(1, 0); options.ReportApiVersions = true; }); 14. Đàm phán nội dung Ý tưởng Đàm phán nội dung cho phép API phân phát các định dạng phản hồi khác nhau dựa trên tiêu đề Chấp nhận trong yêu cầu, cho phép hỗ trợ các định dạng như JSON, XML, v.v. Ví dụ về mã builder.Services.AddControllers() .AddXmlDataContractSerializerFormatters(); 15. Cài đặt tuần tự hóa JSON tùy chỉnh Ý tưởng Tùy chỉnh định dạng phản hồi JSON, chẳng hạn như đặt tên CamelCase hoặc bỏ qua các giá trị null, bằng cách định cấu hình cài đặt trình tuần tự hóa JSON. Ví dụ về mã builder.Services.AddControllers() .AddJsonOptions(options => { options.JsonSerializerOptions.PropertyNamingPolicy = JsonNamingPolicy.CamelCase; options.JsonSerializerOptions.IgnoreNullValues = true; }); 16. Cấu hình CORS Ý tưởng Chia sẻ tài nguyên giữa các nguồn gốc (CORS) cho phép API của bạn được gọi từ các ứng dụng web được lưu trữ trên các miền khác nhau. Định cấu hình chính sách CORS theo yêu cầu của bạn. Ví dụ về mã builder.Services.AddCors(options => { options.AddPolicy("AllowSpecificOrigin", builder => builder.WithOrigins("http://example.com")); }); app.UseCors("AllowSpecificOrigin"); 17. Xác thực Ý tưởng Bảo mật API của bạn bằng cách bật xác thực, xác minh danh tính của người dùng hoặc dịch vụ đưa ra yêu cầu. Ví dụ về mã builder.Services.AddAuthentication("Bearer") .AddJwtBearer(options => { options.Authority = "https://your-auth-server"; options.Audience = "your-api"; }); 18. Ủy quyền Ý tưởng Sau khi xác thực, ủy quyền sẽ xác định xem người dùng được xác thực có quyền thực hiện một hành động hoặc truy cập tài nguyên hay không. Ví dụ về mã [Authorize] public class SecureController : ControllerBase { // Action methods here } 19. Tích hợp Swagger/OpenAPI Ý tưởng Swagger (OpenAPI) cung cấp tài liệu tương tác cho API của bạn, cho phép các nhà phát triển hiểu và sử dụng nó một cách dễ dàng. Ví dụ về mã builder.Services.AddEndpointsApiExplorer(); builder.Services.AddSwaggerGen(); app.UseSwagger(); app.UseSwaggerUI(); 20. Ghi nhật ký Ý tưởng .NET Core cung cấp một khung ghi nhật ký tích hợp có thể ghi nhật ký các thông báo đến nhiều đầu ra khác nhau (bảng điều khiển, cửa sổ gỡ lỗi, dịch vụ bên ngoài, v.v.). Ví dụ về mã logger.LogInformation("This is an informational message"); app.Use(async (context, next) => { logger.LogError("This is an error message before the next middleware"); await next.Invoke(); // Log after calling the next middleware }); 21. Sử dụng lõi khung thực thể Ý tưởng Entity Framework Core là ORM được sử dụng để truy cập dữ liệu trong các ứng dụng .NET. Nó cho phép bạn truy vấn và thao tác dữ liệu bằng cách sử dụng các đối tượng được gõ mạnh. Ví dụ về mã public class MyDbContext : DbContext { public MyDbContext(DbContextOptions options) : base(options) {} public DbSet MyModels { get; set; } } 22. Di chuyển trong lõi khung thực thể Ý tưởng Quá trình di chuyển cho phép bạn áp dụng kiểm soát phiên bản cho lược đồ cơ sở dữ liệu bằng cách theo dõi các thay đổi trong mô hình dữ liệu của bạn. Ví dụ về mã dotnet ef migrations add InitialCreate dotnet ef database update 23. Mẫu kho lưu trữ Ý tưởng Mẫu Kho lưu trữ trừu tượng hóa lớp dữ liệu, làm cho ứng dụng của bạn trở nên mô-đun hơn và dễ bảo trì hơn. Ví dụ về mã public interface IRepository { Task > GetAllAsync(); Task GetByIdAsync(int id); // Other methods... } public class MyRepository : IRepository where T : class { private readonly MyDbContext _context; public MyRepository(MyDbContext context) { _context = context; } // Implement methods... } 24. Kiểm tra đơn vị Ý tưởng Kiểm tra đơn vị đảm bảo API Web của bạn hoạt động chính xác bằng cách kiểm tra từng đơn vị mã riêng lẻ. Ví dụ về mã public class MyControllerTests { [Fact] public async Task Get_ReturnsExpectedValue() { // Arrange var serviceMock = new Mock (); serviceMock.Setup(service => service.GetAsync()).ReturnsAsync("test"); var controller = new MyController(serviceMock.Object); // Act var result = await controller.Get(); // Assert Assert.Equal("test", result.Value); } } 25. Tích hợp với Front-end Ý tưởng .NET Web API có thể đóng vai trò là phần phụ trợ cho ứng dụng giao diện người dùng, cung cấp các dịch vụ RESTful. Ví dụ về mã fetch('https://localhost:5001/mycontroller') .then(response => response.json()) .then(data => console.log(data)); 26. Kiểm tra sức khỏe Ý tưởng Kiểm tra tình trạng cung cấp một cách để theo dõi trạng thái ứng dụng của bạn và các phần phụ thuộc của nó, hữu ích cho kiến trúc vi dịch vụ. Ví dụ về mã builder.Services.AddHealthChecks(); app.MapHealthChecks("/health"); 27. Sử dụng SignalR để liên lạc theo thời gian thực Ý tưởng SignalR kích hoạt chức năng web theo thời gian thực, cho phép mã phía máy chủ gửi thông báo không đồng bộ đến các ứng dụng web phía máy khách. Ví dụ về mã public class MyHub : Hub { public async Task SendMessage(string user, string message) { await Clients.All.SendAsync("ReceiveMessage", user, message); } } 28. Định cấu hình bộ nhớ đệm phản hồi Ý tưởng Bộ nhớ đệm phản hồi giúp giảm số lượng yêu cầu mà máy chủ phải xử lý bằng cách lưu trữ bản sao của các tài nguyên được yêu cầu trước đó. Ví dụ về mã [HttpGet("{id}")] [ResponseCache(Duration = 60)] public IActionResult GetById(int id) { // Retrieve and return your resource } 29. Tệp tĩnh Ý tưởng Việc cung cấp các tệp tĩnh (HTML, CSS, JavaScript, v.v.) là điều cần thiết để sao lưu các ứng dụng giao diện người dùng bằng API Web .NET. Ví dụ về mã app.UseStaticFiles(); // Enable static file serving 30. Cấu hình nâng cao và mẫu tùy chọn Ý tưởng Mẫu tùy chọn sử dụng các lớp để thể hiện các nhóm cài đặt liên quan. Sử dụng IOptions , bạn có thể truy cập các cài đặt này ở bất kỳ đâu trong ứng dụng của mình. Ví dụ về mã public class MySettings { public string Setting1 { get; set; } // Other settings } builder.Services.Configure (builder.Configuration.GetSection("MySettings")); public class MyService { private readonly MySettings _settings; public MyService(IOptions settings) { _settings = settings.Value; } // Use _settings.Setting1 } 31. Phần mềm trung gian tùy chỉnh Ý tưởng Middleware là phần mềm được tập hợp thành một hệ thống ứng dụng để xử lý các yêu cầu và phản hồi. Phần mềm trung gian tùy chỉnh có thể được tạo để thực hiện các tác vụ cụ thể. Ví dụ về mã public class MyCustomMiddleware { private readonly RequestDelegate _next; public MyCustomMiddleware(RequestDelegate next) { _next = next; } public async Task Invoke(HttpContext httpContext) { // Pre-processing logic here await _next(httpContext); // Call the next middleware in the pipeline // Post-processing logic here } } // Extension method for easy middleware registration public static class MyCustomMiddlewareExtensions { public static IApplicationBuilder UseMyCustomMiddleware(this IApplicationBuilder builder) { return builder.UseMiddleware (); } } 32. Giới hạn tỷ lệ Ý tưởng Giới hạn tỷ lệ bảo vệ API của bạn khỏi bị sử dụng quá mức bằng cách giới hạn tần suất người dùng có thể thực hiện yêu cầu trong một khung thời gian nhất định. Ví dụ về mã // Assume using a third-party library like AspNetCoreRateLimit builder.Services.AddInMemoryRateLimiting(); builder.Services.Configure (options => { options.GeneralRules = new List { new RateLimitRule { Endpoint = "*", Limit = 100, Period = "1h" } }; }); 33. Xác thực khóa API Ý tưởng Khóa API là một cách đơn giản để xác thực và ủy quyền các lệnh gọi API. Chúng được chuyển từ máy khách này sang máy chủ khác trong chuỗi truy vấn hoặc tiêu đề. Ví dụ về mã public class ApiKeyMiddleware { private readonly RequestDelegate _next; private const string APIKEYNAME = "x-api-key"; public ApiKeyMiddleware(RequestDelegate next) { _next = next; } public async Task Invoke(HttpContext context) { if (!context.Request.Headers.TryGetValue(APIKEYNAME, out var extractedApiKey)) { context.Response.StatusCode = 401; await context.Response.WriteAsync("API Key was not provided."); return; } // Validate the extracted API Key here... await _next(context); } } 34. Bộ nhớ đệm đầu ra Ý tưởng Bộ nhớ đệm đầu ra cho phép bạn lưu trữ phản hồi cho một yêu cầu. Các yêu cầu tiếp theo có thể được phục vụ từ bộ đệm, cải thiện đáng kể hiệu suất. Ví dụ về mã [HttpGet] [ResponseCache(Duration = 120, Location = ResponseCacheLocation.Client, NoStore = false)] public IActionResult Get() { // Your logic here } 35. Nhiệm vụ nền Ý tưởng Tác vụ nền cho phép các hoạt động chạy ở chế độ nền, độc lập với yêu cầu của người dùng, như gửi email hoặc xử lý các công việc chạy trong thời gian dài. Ví dụ về mã public class MyBackgroundService : BackgroundService { protected override async Task ExecuteAsync(CancellationToken stoppingToken) { while (!stoppingToken.IsCancellationRequested) { // Your background task logic here await Task.Delay(TimeSpan.FromHours(1), stoppingToken); } } } 36. WebSockets Ý tưởng WebSockets cung cấp kênh liên lạc song công hoàn toàn qua một kết nối lâu dài, lý tưởng cho các ứng dụng thời gian thực. Ví dụ về mã app.UseWebSockets(); app.Use(async (context, next) => { if (context.WebSockets.IsWebSocketRequest) { WebSocket webSocket = await context.WebSockets.AcceptWebSocketAsync(); // Handle the WebSocket request here } else { await next(); } }); 37. Yêu cầu bản địa hóa Ý tưởng Bản địa hóa yêu cầu cung cấp cách bản địa hóa nội dung cho các nền văn hóa và ngôn ngữ khác nhau, dựa trên thông tin của yêu cầu. Ví dụ về mã var supportedCultures = new[] { "en-US", "fr-FR" }; var localizationOptions = new RequestLocalizationOptions() .SetDefaultCulture(supportedCultures[0]) .AddSupportedCultures(supportedCultures) .AddSupportedUICultures(supportedCultures); app.UseRequestLocalization(localizationOptions); 38. Tích hợp với GraphQL Ý tưởng GraphQL là ngôn ngữ truy vấn dành cho API. Việc tích hợp API Web .NET với GraphQL cho phép truy xuất dữ liệu hiệu quả hơn. Ví dụ về mã // Assume using a library like HotChocolate builder.Services .AddGraphQLServer() .AddQueryType (); app.MapGraphQL(); 39. Giám sát và đo từ xa Ý tưởng Giám sát và đo từ xa liên quan đến việc thu thập, phân tích và hành động dựa trên dữ liệu về hiệu suất và cách sử dụng ứng dụng của bạn. Ví dụ về mã // Assume using Application Insights builder.Services.AddApplicationInsightsTelemetry("YOUR_INSTRUMENTATION_KEY"); 40. Trung tâm SignalR và giao tiếp thời gian thực Ý tưởng SignalR là thư viện giúp đơn giản hóa việc thêm chức năng web thời gian thực vào ứng dụng. Chức năng web thời gian thực là khả năng yêu cầu mã máy chủ đẩy nội dung đến các máy khách được kết nối ngay lập tức khi nó xảy ra, không yêu cầu máy chủ phải đợi máy khách yêu cầu dữ liệu mới. SignalR hoàn hảo để phát triển các ứng dụng trò chuyện, bảng điều khiển thời gian thực và nhiều ứng dụng web tương tác hơn. Ví dụ về mã public class ChatHub : Hub { public async Task SendMessage(string user, string message) { // Call the broadcastMessage method to update clients. await Clients.All.SendAsync("broadcastMessage", user, message); } } // Startup or Program.cs app.MapHub ("/chathub"); Tích hợp trong Program.cs: public void Configure(IApplicationBuilder app, IWebHostEnvironment env) { // Other configurations... app.UseEndpoints(endpoints => { endpoints.MapHub ("/chathub"); }); } 41. Lõi khung thực thể nâng cao - Mối quan hệ Ý tưởng Entity Framework Core cho phép ánh xạ các mối quan hệ phức tạp giữa các thực thể, chẳng hạn như một-một, một-nhiều và nhiều-nhiều. Ví dụ về mã public class Author { public int AuthorId { get; set; } public string Name { get; set; } public ICollection Books { get; set; } } public class Book { public int BookId { get; set; } public string Title { get; set; } public int AuthorId { get; set; } public Author Author { get; set; } } 42. Thuộc tính xác thực tùy chỉnh Ý tưởng Các thuộc tính xác thực tùy chỉnh cho phép bạn xác định logic xác thực của mình cho các mô hình dữ liệu, mở rộng các thuộc tính xác thực tích hợp sẵn. Ví dụ về mã public class MyCustomValidationAttribute : ValidationAttribute { protected override ValidationResult IsValid(object value, ValidationContext validationContext) { // Your custom validation logic here if (value is int intValue && intValue > 0) { return ValidationResult.Success; } return new ValidationResult("Value must be positive"); } } public class MyModel { [MyCustomValidationAttribute] public int MyProperty { get; set; } } 43. Kịch bản cấu hình nâng cao Ý tưởng Mẫu tùy chọn của .NET hỗ trợ các kịch bản cấu hình phức tạp, bao gồm các đối tượng lồng nhau, danh sách và xác thực. Ví dụ về mã public class MyOptions { public MyNestedOptions Nested { get; set; } public List Items { get; set; } } public class MyNestedOptions { public string Key { get; set; } } // In Program.cs or Startup.cs builder.Services.Configure (builder.Configuration.GetSection("MyOptions")); 44. Giám sát hiệu suất và lập hồ sơ Ý tưởng Giám sát và lập hồ sơ ứng dụng có thể xác định các điểm nghẽn và sự kém hiệu quả, điều cần thiết để tối ưu hóa hiệu suất. Ví dụ về mã app.UseMiniProfiler(); 45. Tài liệu API với nhận xét Swagger và XML Ý tưởng Nâng cao tài liệu API của bạn bằng cách tích hợp nhận xét XML vào giao diện người dùng Swagger của bạn, mang lại trải nghiệm phong phú hơn cho các nhà phát triển sử dụng API của bạn. Ví dụ về mã builder.Services.AddSwaggerGen(c => { var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml"; var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile); c.IncludeXmlComments(xmlPath); }); 46. Toàn cầu hóa và địa phương hóa Ý tưởng Toàn cầu hóa và bản địa hóa cho phép ứng dụng của bạn hỗ trợ nhiều ngôn ngữ và văn hóa, giúp khán giả toàn cầu có thể truy cập ứng dụng đó. Ví dụ về mã builder.Services.AddLocalization(options => options.ResourcesPath = "Resources"); app.UseRequestLocalization(app.Services.GetRequiredService >().Value); 47. Tiêu đề bảo mật Ý tưởng Cải thiện tính bảo mật của ứng dụng web của bạn bằng cách thêm các tiêu đề HTTP khác nhau có thể bảo vệ khỏi các cuộc tấn công và lỗ hổng phổ biến. Ví dụ về mã app.UseHsts(); app.UseXContentTypeOptions(); app.UseReferrerPolicy(opts => opts.NoReferrer()); app.UseXXssProtection(options => options.EnabledWithBlockMode()); app.UseXfo(options => options.Deny()); 48. Cờ tính năng Ý tưởng Cờ tính năng cho phép bạn bật và tắt các tính năng của ứng dụng mà không cần triển khai mã mới, tạo điều kiện cho việc thử nghiệm và triển khai dễ dàng hơn. Ví dụ về mã // Using a library like Microsoft.FeatureManagement builder.Services.AddFeatureManagement(); 49. Tích hợp Blazor Ý tưởng Blazor cho phép bạn xây dựng giao diện người dùng web tương tác bằng C# thay vì JavaScript. Việc tích hợp Blazor với API Web mang lại trải nghiệm phát triển toàn diện liền mạch. Ví dụ về mã // In a Blazor Server app @code { private IEnumerable forecasts; protected override async Task OnInitializedAsync() { forecasts = await Http.GetFromJsonAsync ("WeatherForecast"); } } 50. Middleware nâng cao để nén phản hồi Ý tưởng Tính năng nén phản hồi có thể giảm kích thước phản hồi API của bạn, cải thiện thời gian tải cho khách hàng qua mạng chậm. Ví dụ về mã builder.Services.AddResponseCompression(options => { options.Providers.Add (); options.EnableForHttps = true; }); app.UseResponseCompression(); Lập trình C#🚀 Cảm ơn bạn đã là thành viên của cộng đồng C#! Trước khi bạn đi: Nếu bạn đã làm được đến mức này, hãy thể hiện sự đánh giá cao của bạn bằng một tràng pháo tay và theo dõi tác giả! 👏️️ Theo dõi chúng tôi: | | | | | X LinkedIn Dev.to Nút băm Bản tin tumblr Truy cập các nền tảng khác của chúng tôi: | | | | GitHub Instagram Tiktok Quora Daily.dev Cũng được xuất bản ở đây