在 ASP.NET Core web api 中，如何在使用 NSwag.AspNetCore 时向 swagger UI 添加示例请求？

Question

我正在使用

<PackageReference Include="NSwag.AspNetCore" Version="13.8.2" />

在 asp.net 核心 Web api 3.1 项目中，我有兴趣在 swaggerUI 中显示示例请求负载。

在使用这个框架时我该如何添加示例请求？这个框架甚至有可能吗？我最好的猜测是向控制器操作添加属性。任何见解在这里表示赞赏。也许这个问题的答案是一个简单的注释，我希望如此。

Answer 1

您的意思是要将示例数据添加到操作中吗？如果是，您可以使用：

/// <example>xxx</example>

这是一个演示：

Sample.cs:

public class Sample
    {
        /// <example>1</example>
        public int Id { get; set; }
        /// <example>name</example>
        public string Name { get; set; }
        /// <example>address</example>
        public string Address { get; set; }
    }

控制器：

[ApiController]
    [Route("[controller]")]
    public class ApiController : ControllerBase
    {
        [HttpPost("Index")]
        public Sample Index(Sample sample)
        {
            return sample;
        }
    }

结果：

在 ASP.NET Core web api 中，如何在使用 NSwag.AspNetCore 时向 swagger UI 添加示例请求？

In ASP.NET Core webapi how to I add sample requests to swaggerUI when using NSwag.AspNetCore?

asp.net-core

nswag