4

我正在使用新的 Azure API 应用程序（Visual Studio 2013 中的模板，带有 3/24/15 的新 SDK 位），我想让我的 Swagger UI 按版本号对我的调用进行分组。就我而言，我目前正在通过 URI 进行版本控制（我意识到 REST 纯粹主义者会告诉我不要这样做 - 请不要尝试在这里“纠正我的错误”）。例如，我可能有这些电话：

http://example.com/api/Contacts <-- "latest"
http://example.com/api/1/Contacts
http://example.com/api/2/Contacts
http://example.com/api/Contacts{id} <-- "latest"
http://example.com/api/1/Contacts/{id}
http://example.com/api/2/Contacts/{id}

从功能上讲，这很好用！（是的，我知道你们中的一些人会畏缩。抱歉，这伤害了您的感受。）但是，我的问题是 W/Swagger UI 组织。默认情况下，Swagger UI 按控制器名称（Contacts在本例中）对这些进行分组。我在SwaggerConfig.cs文件中看到我可以改变这个：

// Each operation be assigned one or more tags which are then used by consumers for various reasons.
// For example, the swagger-ui groups operations according to the first tag of each operation.
// By default, this will be controller name but you can use the "GroupActionsBy" option to
// override with any value.
//
//c.GroupActionsBy(apiDesc => apiDesc.HttpMethod.ToString());

我不明白的是如何调整它以将所有“最新”组合在一起，然后将所有 v1 组合在一起，然后将所有 v2 组合在一起，等等。

我怎样才能做到这一点？如果绝对必须要求我在路径中添加“最新”（或等效）一词来代替版本号，那么我可以这样做，但我不想这样做。

4

1 回答 1

6

我相信您要做的是取消注释 SwaggerConfig.cs 中该行下方几行的注释

c.OrderActionGroupsBy(new DescendingAlphabeticComparer());

除非您将类的名称更改为 ApiVersionComparer() 之类的名称，然后将其实现为新类：

public class ApiVersionComparer : IComparer<string>
{

    public int Compare(string x, string y)
    {
        // Write whatever comparer you'd like to here.
        // Yours would likely involve parsing the strings and having
        // more complex logic than this....
        return -(string.Compare(x, y));
    }
}

如果您已经足够远地提出这个问题，我相信我可以将排序实现留给您。:-)

于 2015-04-29T00:43:14.727 回答