微信公众号搜"智元新知"关注
微信扫一扫可直接关注哦!

在Swagger中更改API路由名称

如何解决在Swagger中更改API路由名称

有人对如何更改swagger上的API调用名称有确切的想法吗,确切地显示'/ api / Users',但我希望它显示'GetUsersByID ,如果您在下面的图片中看到路线刚到。我已经厌倦了[HttpGET("{id}",Name = "GetUsersByID")]的使用,但是大摇大摆似乎忽略了这一点。 Screenshot Here

我正在使用.Net Core 3.1和最新的swashbuckle nuget。任何帮助将不胜感激。

解决方法

@nalnpir回答了您提出的问题,但是 GetUsersByID是REST API的可怕名称,您不应使用它。它显示了一个非常RPC-like interface,并且根本不是REST。

阅读此 REST Resource Naming Guide 以获得更多详细信息,如果您今天感觉很好,您应该观看这部有趣的视频,尽管有趣,但它非常有用:-D

video You Give Rest a Bad Name

,

我不知道格式,因为即时阅读是自动的,并且是框架附带的,但是它适用于您发送的标头,默认情况下是json,如果您指定xml,它将是xml

但是您想要实现的目标非常简单,更改您的方法标签,使其看起来像这样

[HttpGet]
[Route("GetUsersByID"]
public async Task<IActionResult> YourMethod(int id)
{
//code of your method
}

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。