ASP.NETCoreAPI中使用GET请求的可选参数未能与Swagger配合使用。
创始人
2024-09-17 18:31:44
0次

问题出现的原因是Swagger并不支持GET请求中的可选参数。但是可以使用另一种方式来实现同样的功能,即在GET请求中使用查询字符串来传递参数。

以下是一个示例代码,其中我们将应用程序的“WeatherForecast”控制器中的GET请求的可选参数转换为查询字符串:

[HttpGet]
public IEnumerable Get([FromQuery] string startDate = null, [FromQuery] string endDate = null)
{
    DateTime startDateTime;
    DateTime endDateTime;
    bool validStartDate = DateTime.TryParse(startDate, out startDateTime);
    bool validEndDate = DateTime.TryParse(endDate, out endDateTime);

    // If the start date and end date are both provided, only return results that fall within the specified range.
    if (validStartDate && validEndDate)
    {
        return _data.Where(x => x.Date >= startDateTime && x.Date <= endDateTime);
    }

    // If only the start date is provided, return results that occurred on or after that date.
    if (validStartDate)
    {
        return _data.Where(x => x.Date >= startDateTime);
    }

    // If only the end date is provided, return results that occurred on or before that date.
    if (validEndDate)
    {
        return _data.Where(x => x.Date <= endDateTime);
    }

    // If neither date is provided, return all results.
    return _data;
}

在上面的示例代码中,我们使用[FromQuery]注释来将查询字符串参数映射到函数参数。startDate和endDate参数都具有默认值为null,以便它们在没有传递值的情况下成为可选参数。我们还在函数内部检查了这些参数,以确定它们是否包含有效的日期值。

最后,我们使用数据集*_data*返回筛选后的结果。如果没有传递任何参数,则返回所有记录。

相关内容

热门资讯

前端-session、jwt 目录:   (1)session (2&#x...
linux入门---制作进度条 了解缓冲区 我们首先来看看下面的操作: 我们首先创建了一个文件并在这个文件里面添加了...
关于测试,我发现了哪些新大陆 关于测试 平常也只是听说过一些关于测试的术语,但并没有使用过测试工具。偶然看到编程老师...
前缀和与对数器与二分法 1. 前缀和 假设有一个数组,我们想大量频繁的去访问L到R这个区间的和,...
nodejs:本地安装nvm实... 一、背景-使用不同版本node的原因 vue3+ts、nuxt3版本,node...
JAVA集合知识整理 Java集合知识整理 HashMap相关 HashMap的底层数据结构:jdk1.8之...
无刷直流电机介绍及单片机控制实... 无刷直流电机介绍及单片机控制实例前言基本概念优势与劣势使用寿命基本结构使用单片机控制实例电子调速器&...
fwdiary(2) dp2 1.传纸条  AcWing 275. 传纸条 - AcWing 走两条路,走一条最大的...
常用的DOS命令 常用的DOS命令 DOS(Disk Operating System,磁...
<C++> 类和对象(下) 1.const成员函数将const修饰的“成员函数”称之为const成员函数,cons...