FastEndpoints中处理纯路由参数请求DTO的415错误解决方案

在FastEndpoints框架中开发RESTful API时，开发者可能会遇到一个特殊场景：当创建一个POST端点且请求DTO的所有属性都来自路由参数时，框架会返回415 Unsupported Media Type错误。本文将深入分析这一现象的原因，并提供专业的解决方案。

问题现象分析

假设我们有以下端点设计：

• 路由路径：POST /users/{userId}/contacts/{contactId}/disable
• 功能：禁用指定联系人并返回联系人数据

开发者最初可能采用两种实现方式：

1. 使用EmptyRequest作为请求DTO：

public class PostDisableUserContact : Endpoint<EmptyRequest, ContactDto>
{
    public override void Configure()
    {
        Post("/users/{userId}/contacts/{contactId}/disable");
    }
    
    public override async Task HandleAsync(EmptyRequest req, CancellationToken ct)
    {
        var userId = Route<int>("userId");
        var contactId = Route<int>("contactId");
        // 业务逻辑处理
    }
}

这种方式可以正常工作。

2. 使用包含路由参数的请求DTO：

public record DisableUserContactDto(int UserId, int ContactId);

public class PostDisableUserContact : Endpoint<DisableUserContactDto, ContactDto>
{
    public override void Configure()
    {
        Post("/users/{userId}/contacts/{contactId}/disable");
    }
    
    public override async Task HandleAsync(DisableUserContactDto req, CancellationToken ct)
    {
        // 直接使用req.UserId和req.ContactId
    }
}

这种方式会返回415错误。

问题根源

FastEndpoints框架默认会为POST请求添加JSON body的媒体类型接受设置。当请求DTO的所有属性都来自路由参数时：

1. 框架仍然期望客户端发送一个JSON body
2. 但实际上请求体为空（因为所有参数都在路由中）
3. 导致415 Unsupported Media Type错误

专业解决方案

要解决这个问题，我们需要显式地清除或重新定义端点的"accepts"元数据。以下是推荐的解决方案：

public class PostDisableUserContact : Endpoint<DisableUserContactDto, ContactDto>
{
    public override void Configure()
    {
        Post("/users/{userId}/contacts/{contactId}/disable");
        // 关键配置：清除默认的accepts设置
        Description(x => x.Accepts<DisableUserContactDto>(false));
    }
    
    public override async Task HandleAsync(DisableUserContactDto req, CancellationToken ct)
    {
        // 业务逻辑处理
    }
}

最佳实践建议

1. 明确设计意图：如果端点确实不需要请求体，应该使用EmptyRequest或自定义的请求DTO并正确配置

2. 保持一致性：在整个项目中统一处理这类端点的方式，便于团队理解和维护

3. 文档注释：为这类特殊端点添加详细注释，说明其参数来源和设计考虑

4. 测试验证：编写单元测试和集成测试，确保端点在不同场景下的行为符合预期

通过理解FastEndpoints框架的这一行为特性，开发者可以更灵活地设计API端点，同时避免常见的415错误陷阱。