通过属性在NSwag中指定自定义端点标题

时间:2018-08-31 14:44:28

标签: c# asp.net-core asp.net-core-webapi nswag

类似于to this question,但略有不同,我只是想看看是否已经存在一种通过例如方法本身的属性来生成端点标题的简便方法?

例如,我会为用户控制器中的HttpGetHttpPost端点生成默认的 Users_Get Users_Post 希望能够为其命名为“获取特定用户”和“创建新用户”。

由于我们已经可以使用[Description()]属性来对描述进行建模,所以我希望为标题使用另一个属性。我的想法是,它可能看起来像以下内容:

[ApiController]
public class UsersController : ControllerBase
{
    [HttpPost]
    [Display(Name = "Create a new user")]
    public void Post([FromBody] string value)
    {
        ...
    }
}

我知道我可能可以实现自定义IOperationNameGenerator,但是这似乎是一个常见的用例,因此我想排除自己已经错过了可能的事情。谢谢!

编辑:

为了澄清,我的意思是让所需的标题成为Swagger JSON规范中的summary属性,而使具有DescriptionAttribute值的奖励积分成为规范中的description属性。看来DescriptionAttribute正在被馈送到summary属性中。

0 个答案:

没有答案