c# - 为 swagger 的“试用”指定示例请求
问题描述
有没有办法指定招摇的示例请求?甚至可能是多个?
该Try it out
按钮仅显示通用值,例如:
{
"firstName": "string",
"lastName": "string"
}
为了
public class User
{
public string FirstName { get; set; }
public string LastName { get; set; }
}
当您必须首先编辑所有值时,使用大型对象变得非常困难。我知道我可以使用 Postman,我也这样做,但是能够使用 swagger 创建多个好看且有用的示例将非常好。
解决方案
使用 ASP.NET Core 3.1、Swagger OAS 3 和 Swashbuckle.AspNetCore 5.4.1,以下模型类 + XML 注释适用于我:-
/// <summary>
/// A user.
/// </summary>
public class User
{
/// <summary>
/// The user's first name.
/// </summary>
/// <example>Jane</example>
public string FirstName { get; set; }
/// <summary>
/// The user's last name.
/// </summary>
/// <example>Austin</example>
public string LastName { get; set; }
}
现在,当我单击“试用”(对于User
在消息正文中采用模型的 POST 操作)时,我得到默认值:-
{
"firstName": "Jane",
"lastName": "Austin"
}
推荐阅读
- excel - Excel:如何仅在最大值大于最小值的某个值时突出显示每行的最大值?
- javascript - 导航栏(折叠)按钮不起作用 Bootstrap 5.1.3
- python - 创建新列并根据其他列值填充它们
- ios - 在 IOS 设备上测试 localhost:8080
- javascript - CSP 错误时 window.onerror 不起作用
- amazon-web-services - CloudFormation 条件函数 Fn::Join: 的 yaml 语法问题 !Join 指定多个资源 arn 值
- admob - AdMob 检查持续 4 个月
- javascript - wordpress 中显示的砌体错误
- sqlite - 两列的不同组合与第三列的排序?
- flutter - 颤动图像放大并拖动