C# Core Web API控制器GetAll方法可选参数默认值配置问询

你的需求完全可以通过ASP.NET Core自带的模型绑定能力实现，不需要额外复杂配置。先给你整理好完整的代码示例，再逐个解释细节：

// 控制器上的路由要和你的请求路径对应，比如这样设置
[Route("crm/contacts")]
[ApiController]
public class ContactsController : ControllerBase
{
    [HttpGet]
    [Route("")] // 这个空路由和控制器路由组合后就是 /crm/contacts
    public async Task<DTO.CRM.contact[]> GetAllAsync(
        // from可选，默认null
        int? from = null,
        // take可选，默认10；可以加Range验证防止非法值
        [Range(1, int.MaxValue)] int? take = 10,
        // search可选，默认null，自动处理URL编码的字符串（比如My%20Customer会解析成"My Customer"）
        string search = null,
        // sort可选，默认null
        string sort = null)
    {
        // 这里写你的业务逻辑，比如根据参数过滤、分页、排序
        // 示例：
        var query = _dbContext.Contacts.AsQueryable();
        
        if (!string.IsNullOrEmpty(search))
        {
            query = query.Where(c => c.Name.Contains(search));
        }
        
        if (!string.IsNullOrEmpty(sort))
        {
            // 根据sort参数处理排序，比如switch判断字段
            query = sort switch
            {
                "created_by" => query.OrderBy(c => c.CreatedBy),
                // 其他排序规则...
                _ => query.OrderBy(c => c.Id)
            };
        }
        
        if (from.HasValue)
        {
            query = query.Skip(from.Value);
        }
        
        query = query.Take(take.Value);
        
        return await query.ToArrayAsync();
    }
}

为什么这样写能满足你的所有请求场景？ #

• 无参数请求 /crm/contacts：所有参数都会使用默认值，from=null、take=10、search=null、sort=null，完全符合预期。
• 单参数请求：比如/crm/contacts?sort=created_by或/crm/contacts?search=My%20Customer，模型绑定会自动把对应参数赋值，其他参数保持默认值。
• 多参数组合：不管是sort+take、from+take还是三个参数一起传，ASP.NET Core都会正确绑定每个存在的查询参数，忽略不存在的（用默认值）。
• URL编码处理：像My%20Customer这种带空格的URL编码字符串，框架会自动解码成"My Customer"赋值给search参数，不用你手动处理。

额外优化建议 #

• 加上[ApiController]特性：它会自动帮你做很多事情，比如模型验证失败时返回400错误，不需要手动判断ModelState。
• 给数值参数加验证：比如上面的[Range(1, int.MaxValue)]给take，如果客户端传take=0或者负数，会直接返回400，避免业务逻辑里处理非法值。
• 如果排序字段较多，可以考虑用反射或者AutoMapper的ProjectTo来简化排序逻辑，避免写一堆switch分支。

内容的提问来源于stack exchange，提问作者Luke1988