FastEndpoints中路由参数类型定义的最佳实践
在使用FastEndpoints框架开发API时,正确设置路由参数的数据类型对于生成准确的客户端代码至关重要。本文将详细介绍如何确保路由参数在Swagger文档和生成的客户端代码中保持正确的数据类型。
问题背景
开发者在FastEndpoints框架中定义了一个接收Guid类型路由参数的端点,但在使用GenerateClientsAndExitAsync方法生成客户端代码时,发现路由参数被生成为string?类型,而非期望的Guid类型。这会导致客户端调用时需要额外的类型转换,影响开发体验。
解决方案
使用请求DTO定义路由参数类型
FastEndpoints框架的客户端代码生成依赖于Swagger文档的准确描述。为了确保路由参数在Swagger文档中被正确识别为Guid类型,最佳实践是使用请求DTO来明确定义参数类型:
sealed class RequestDto
{
public Guid SomeId { get; set; } // 明确指定参数为Guid类型
}
sealed class ResponseDto
{
public string Id { get; set; }
}
sealed class GetSomeEndpoint : Endpoint<RequestDto, ResponseDto>
{
public override void Configure()
{
Get("something/{SomeId}");
AllowAnonymous();
}
public override async Task HandleAsync(RequestDto r, CancellationToken ct)
{
await SendAsync(new() { Id = r.SomeId.ToString() });
}
}
工作原理
-
Swagger文档生成:当使用请求DTO时,FastEndpoints框架会根据DTO属性类型在Swagger文档中正确标注参数类型。对于Guid类型的属性,Swagger会生成相应的schema定义。
-
客户端代码生成:基于正确的Swagger文档,客户端生成工具(如NSwag)能够识别参数应为Guid类型而非字符串类型,从而生成类型正确的客户端方法签名。
替代方案比较
虽然可以通过Route()方法在端点处理程序中获取Guid类型的路由参数,但这种方法不会影响Swagger文档的生成。因此,对于需要生成客户端代码的场景,使用请求DTO是更可靠的方法。
额外建议
-
考虑使用Kiota客户端生成:FastEndpoints现在支持基于Kiota的客户端生成方案,它提供了更现代化的客户端生成体验,值得开发者评估使用。
-
保持一致性:建议在整个项目中统一使用请求DTO来定义所有路由参数,以确保Swagger文档和客户端代码的一致性。
-
文档注释:为DTO属性添加XML注释,这些注释会被包含在Swagger文档中,进一步提升API文档的质量。
通过遵循这些最佳实践,开发者可以确保FastEndpoints应用生成的路由参数类型在客户端代码中保持准确,提高开发效率和代码质量。
PaddleOCR-VLPaddleOCR-VL 是一款顶尖且资源高效的文档解析专用模型。其核心组件为 PaddleOCR-VL-0.9B,这是一款精简却功能强大的视觉语言模型(VLM)。该模型融合了 NaViT 风格的动态分辨率视觉编码器与 ERNIE-4.5-0.3B 语言模型,可实现精准的元素识别。Python00- DDeepSeek-OCR暂无简介Python00
openPangu-Ultra-MoE-718B-V1.1昇腾原生的开源盘古 Ultra-MoE-718B-V1.1 语言模型Python00
HunyuanWorld-Mirror混元3D世界重建模型,支持多模态先验注入和多任务统一输出Python00
AI内容魔方AI内容专区,汇集全球AI开源项目,集结模块、可组合的内容,致力于分享、交流。03
Spark-Scilit-X1-13BFLYTEK Spark Scilit-X1-13B is based on the latest generation of iFLYTEK Foundation Model, and has been trained on multiple core tasks derived from scientific literature. As a large language model tailored for academic research scenarios, it has shown excellent performance in Paper Assisted Reading, Academic Translation, English Polishing, and Review Generation, aiming to provide efficient and accurate intelligent assistance for researchers, faculty members, and students.Python00
GOT-OCR-2.0-hf阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00- HHowToCook程序员在家做饭方法指南。Programmer's guide about how to cook at home (Chinese only).Dockerfile013
Spark-Chemistry-X1-13B科大讯飞星火化学-X1-13B (iFLYTEK Spark Chemistry-X1-13B) 是一款专为化学领域优化的大语言模型。它由星火-X1 (Spark-X1) 基础模型微调而来,在化学知识问答、分子性质预测、化学名称转换和科学推理方面展现出强大的能力,同时保持了强大的通用语言理解与生成能力。Python00- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00