.net core 为参数向swagger UI添加示例值
在.NETCore中是否有任何方法可以将示例值包含到Swagger UI中动作方法的参数中。与响应/请求的示例值显示方式相同 在.net core 为参数向swagger UI添加示例值,.net-core,swagger,asp.net-core-webapi,swagger-ui,.net Core,Swagger,Asp.net Core Webapi,Swagger Ui,在.NETCore中是否有任何方法可以将示例值包含到Swagger UI中动作方法的参数中。与响应/请求的示例值显示方式相同 在.Net core中,似乎没有任何直接的方法,例如SwaggerRequestExample,以便为参数显示示例值 有没有人能帮我找到最初的解决方案或任何我可以开始的链接 我正在寻找下面这样的输出 这是模型对象 public class Vehicle { public long Id { get; set; } public stri
.Net core
中,似乎没有任何直接的方法,例如SwaggerRequestExample
,以便为参数显示示例值
有没有人能帮我找到最初的解决方案或任何我可以开始的链接
我正在寻找下面这样的输出
这是模型对象
public class Vehicle
{
public long Id { get; set; }
public string VehicleName { get; set; }
public int Price { get; set; }
}
这是post方法
[HttpPost]
public void Post(int id, [FromBody] Vehicle val)
{
}
这会将ID显示为参数,但车辆型号不会显示在参数列表中。我希望它显示为示例值。我还在启动文件中配置了以下内容
c.includexmlcoments(xmlPath)代码>默认情况下,Swashback生成并公开正式称为OpenAPI
规范的3.0
版本中的Swagger JSON。为了支持向后兼容性,您可以选择以2.0
格式公开JSON。这种2.0
格式对于当前支持OpenAPI版本2.0
的Microsoft Power Apps和Microsoft Flow等集成非常重要。要选择2.0
格式,请在启动时设置SerializeAsV2
属性。配置:
...
// Enable middleware to serve generated Swagger as a JSON endpoint.
app.UseSwagger(c =>
{
c.SerializeAsV2 = true;
});
...
之前
{
"openapi": "3.0.1",
"info": {
"title": "SwaggerApplication",
"version": "1.0"
},...
之后
{
"swagger": "2.0",
"info": {
"title": "SwaggerApplication",
"version": "1.0"
}, ...
你能把你的代码包括进来吗?NicholasRees我已经编辑了这个问题,把代码包括进去。谢谢@Michael的回答。是的,我可以这样做,但我需要参数描述中的“示例值”。我已经在问题“如何显示”中添加了链接。@Soft_API_Dev,我现在明白你的意思了,你需要的是2.0
UI而不是3.0
,你可以选择上面的2.0格式,测试结果已经发布给你了。这就是我要找的。成功了!谢谢