c# - 是否可以通过 Swashbuckle 包含端点的方法名称？

Question

所以我正在尝试为一组通过 .NET Web API 创建的旧 REST 端点添加 API 文档。有人建议我尝试使用 Swashbuckle 来生成现有端点的文档，这有点管用。

我的问题是这些端点的名称提供了一些上下文，而 Swashbuckle 似乎只选择 Controller 而不是实际的方法名称。例如，我有以下端点:

public class CatalogAvailabilityController
{
    public List<string> GetSupportedCatalogsForCountry([FromUri] string countryCode)
    {
        //--return supported catalogs
    }
}

在这种情况下，生成的 Swagger 输出如下内容:

基本上，它只在 URL 中包含 Controller 名称 (CatalogAvailability)，但我希望它在 URL 中也包含“GetSupportedCatalogsForCountry”。有没有办法让 Swashbuckle 像这样生成它，还是我需要返回并自己创建 Swagger？

是的，理想情况下，它可能不应该像这样设置，它应该更 RESTful，但它是一个较旧的遗留系统，需要付出大量努力才能重构，所以我想我应该先问一下。提前谢谢你。

Answer 1

是的!将 Attributes 添加到您的操作，并将 Route 属性添加到您的 Controller 。

public class CatalogAvailabilityController
{
    [HttpGet]
    public List<string> GetSupportedCatalogsForCountry([FromUri] string countryCode)
    {
        //--return supported catalogs
    }
}