C#中創(chuàng)建統(tǒng)一API接口的實現(xiàn)方案
更新時間：2025年04月04日 08:52:17 作者：老胖閑聊
在 C# 中創(chuàng)建統(tǒng)一 API 接口需要從架構(gòu)設計、技術選型和代碼實現(xiàn)等多個層面進行規(guī)劃,本文給大家詳細介紹了實現(xiàn)方案和完整示例代碼,對大家的學習或工作有一定的幫助,需要的朋友可以參考下
一、技術選型與架構(gòu)設計
框架選擇
- ASP.NET Core (6.0+)
- RESTful API 規(guī)范
核心組件
- 統(tǒng)一響應格式：標準化 JSON 響應結(jié)構(gòu)
- 全局異常處理：統(tǒng)一錯誤返回
- 版本控制：API 版本管理
- 認證授權(quán)：JWT Bearer 認證
- 數(shù)據(jù)驗證：Model Validation
- 日志記錄：Serilog 或內(nèi)置 ILogger
- Swagger 文檔：OpenAPI 規(guī)范支持
架構(gòu)分層
API Layer (Controllers) ↓ Application Layer (Services) ↓ Domain Layer (Models, Interfaces) ↓ Infrastructure Layer (Repositories)
二、完整實現(xiàn)步驟
1. 創(chuàng)建項目
dotnet new webapi -n UnifiedApiDemo
2. 添加 NuGet 包
dotnet add package Microsoft.AspNetCore.Mvc.Versioning dotnet add package Swashbuckle.AspNetCore dotnet add package Microsoft.AspNetCore.Authentication.JwtBearer
三、核心代碼實現(xiàn)
1. 統(tǒng)一響應模型
public class ApiResponse<T>
{
public int Code { get; set; }
public string Message { get; set; }
public T Data { get; set; }
public DateTime Timestamp { get; } = DateTime.UtcNow;
public static ApiResponse<T> Success(T data) => new()
{
Code = 200,
Message = "Success",
Data = data
};
public static ApiResponse<object> Error(int code, string message) => new()
{
Code = code,
Message = message
};
}
2. 全局異常處理中間件
public class ExceptionMiddleware
{
private readonly RequestDelegate _next;
private readonly ILogger<ExceptionMiddleware> _logger;
public ExceptionMiddleware(RequestDelegate next, ILogger<ExceptionMiddleware> logger)
{
_next = next;
_logger = logger;
}
public async Task InvokeAsync(HttpContext context)
{
try
{
await _next(context);
}
catch (Exception ex)
{
_logger.LogError(ex, "Global exception occurred");
await HandleExceptionAsync(context, ex);
}
}
private static Task HandleExceptionAsync(HttpContext context, Exception exception)
{
context.Response.ContentType = "application/json";
context.Response.StatusCode = exception switch
{
ValidationException => StatusCodes.Status400BadRequest,
UnauthorizedAccessException => StatusCodes.Status401Unauthorized,
_ => StatusCodes.Status500InternalServerError
};
return context.Response.WriteAsJsonAsync(ApiResponse<object>.Error(
context.Response.StatusCode,
exception.Message
));
}
}
3. 統(tǒng)一響應包裝過濾器
public class ApiResponseFilter : IAsyncResultFilter
{
public async Task OnResultExecutionAsync(
ResultExecutingContext context,
ResultExecutionDelegate next)
{
if (context.Result is ObjectResult objResult)
{
var apiResponse = ApiResponse<object>.Success(objResult.Value);
context.Result = new ObjectResult(apiResponse)
{
StatusCode = objResult.StatusCode
};
}
await next();
}
}
4. 配置服務（Program.cs）
var builder = WebApplication.CreateBuilder(args);
// 添加版本控制
builder.Services.AddApiVersioning(options =>
{
options.DefaultApiVersion = new ApiVersion(1, 0);
options.AssumeDefaultVersionWhenUnspecified = true;
options.ReportApiVersions = true;
});
// 配置 Swagger
builder.Services.AddSwaggerGen(c =>
{
c.SwaggerDoc("v1", new OpenApiInfo { Title = "Unified API", Version = "v1" });
});
// 添加統(tǒng)一響應過濾器
builder.Services.AddControllers(options =>
{
options.Filters.Add<ApiResponseFilter>();
});
// 配置 JWT 認證
builder.Services.AddAuthentication(JwtBearerDefaults.AuthenticationScheme)
.AddJwtBearer(options =>
{
options.TokenValidationParameters = new TokenValidationParameters
{
ValidateIssuer = true,
ValidIssuer = "your_issuer",
ValidateAudience = true,
ValidAudience = "your_audience",
ValidateLifetime = true,
IssuerSigningKey = new SymmetricSecurityKey(Encoding.UTF8.GetBytes("your_secret_key"))
};
});
var app = builder.Build();
// 中間件管道
app.UseSwagger();
app.UseSwaggerUI();
app.UseMiddleware<ExceptionMiddleware>();
app.UseAuthentication();
app.UseAuthorization();
app.MapControllers();
app.Run();
5. 控制器示例（帶版本控制）
[ApiController]
[Route("api/v{version:apiVersion}/[controller]")]
[ApiVersion("1.0")]
[Authorize]
public class ProductsController : ControllerBase
{
[HttpGet("{id}")]
[ProducesResponseType(typeof(ProductDto), 200)]
public IActionResult GetProduct(int id)
{
var product = new ProductDto { Id = id, Name = "Sample Product" };
return Ok(product);
}
[HttpPost]
[ValidateModel]
public IActionResult CreateProduct([FromBody] ProductCreateDto dto)
{
// 業(yè)務邏輯
return CreatedAtAction(nameof(GetProduct), new { id = 1 }, null);
}
}
6. 模型驗證示例
public class ProductCreateDto
{
[Required]
[StringLength(100)]
public string Name { get; set; }
[Range(0, 10000)]
public decimal Price { get; set; }
}
public class ValidateModelAttribute : ActionFilterAttribute
{
public override void OnActionExecuting(ActionExecutingContext context)
{
if (!context.ModelState.IsValid)
{
var errors = context.ModelState
.Where(e => e.Value.Errors.Count > 0)
.ToDictionary(
kvp => kvp.Key,
kvp => kvp.Value.Errors.Select(e => e.ErrorMessage).ToArray()
);
context.Result = new BadRequestObjectResult(
ApiResponse<object>.Error(400, "Validation Error", errors)
);
}
}
}
四、運行效果示例
成功響應
{
"code": 200,
"message": "Success",
"data": {
"id": 1,
"name": "Sample Product"
},
"timestamp": "2024-02-20T12:34:56Z"
}
錯誤響應
{
"code": 400,
"message": "Validation Error",
"data": {
"Price": ["The field Price must be between 0 and 10000."]
},
"timestamp": "2024-02-20T12:35:10Z"
}
五、擴展建議
- 性能優(yōu)化：添加響應緩存機制
- 監(jiān)控：集成 Application Insights
- 限流：使用 AspNetCoreRateLimit
- DTO 映射：使用 AutoMapper
- 單元測試：使用 xUnit/MSTest
此方案提供了從基礎設施到業(yè)務邏輯的完整統(tǒng)一 API 實現(xiàn)框架，可根據(jù)具體需求進行擴展調(diào)整。
到此這篇關于C#中創(chuàng)建統(tǒng)一API接口的實現(xiàn)方案的文章就介紹到這了,更多相關C#創(chuàng)建統(tǒng)一API接口內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！
相關文章
這篇文章主要介紹了C#?實現(xiàn)Ping遠程主機功能,本教程將演示1.0.2版本更新功能,以及實現(xiàn)的具體代碼演示,需要的朋友可以參考下2024-05-05
這篇文章主要介紹了c#調(diào)用winrar解壓縮文件的方法，大家參考使用吧2013-12-12
這篇文章主要介紹了C# 獲取當前年份的周期，周期所在日期范圍 ,非常不錯，具有一定的參考借鑒價值，需要的朋友可以參考下2018-05-05
矩形數(shù)組是指由相同數(shù)據(jù)類型的元素按照行和列組成的二維數(shù)組,可以使用索引訪問矩形數(shù)組中的單個元素,也可以使用循環(huán)結(jié)構(gòu)遍歷矩形數(shù)組中的所有元素,此外,我們還需要注意不要修改矩形數(shù)組的維度,避免使用矩形數(shù)組造成內(nèi)存占用過高等問題2024-01-01
這篇文章主要為大家整理了一些優(yōu)雅又實用的C#代碼優(yōu)化技巧，文中的示例代碼講解詳細，對我們深入了解C#有一定的幫助，需要的可以參考一下2023-06-06
這篇文章主要為大家詳細介紹了UGUI繪制多點連續(xù)的平滑曲線，具有一定的參考價值，感興趣的小伙伴們可以參考一下2018-12-12
原生實現(xiàn)C#與Lua相互調(diào)用方法(Unity3D可用)
Lua是一種很好的擴展性語言,Lua解釋器被設計成一個很容易嵌入到宿主程序的庫,下面這篇文章主要給大家介紹了關于原生實現(xiàn)C#與Lua相互調(diào)用方法,Unity3D可用的相關資料,需要的朋友可以參考下2022-04-04
C#與js實現(xiàn)去除textbox文本框里面重復記錄的方法
這篇文章主要介紹了C#與js實現(xiàn)去除textbox文本框里面重復記錄的方法,很實用的功能,需要的朋友可以參考下2014-08-08
這篇文章主要介紹了C#中this的使用方法,this是C#程序設計中非常重要的一個關鍵字,本文以實例形式對此作出簡單的用法分析,需要的朋友可以參考下2014-08-08
本篇文章是對以前學習C# clr做的一些筆記，現(xiàn)在拿出來和大家分享下，希望需要的朋友能參考一下2013-05-05