如何通过控制器名称对NSwag swagger.json中的路径进行排序/排序 [英] How to order/sort paths in NSwag swagger.json by controller name

问题描述

我正在使用NSwag为.NET Core API生成招摇工具，并且一切正常，除了渲染路径以使反射似乎将Controller从项目中提取这一事实之外.

I am using NSwag to generate swagger for my .NET Core api and everything works great, except the fact that paths are rendered in order that reflection seems to pickup Controllers from project.

因此，如果我确实具有层次结构-某些控制器位于根级别( Controllers 文件夹)，而某些位于子文件夹( Controllers \ Subfolder 文件夹)，则顺序会混乱.

So if I do have hierarchy - some controllers at root level (Controllers folder) and some in subfolder (Controllers\Subfolder folder) then the order gets messed up.

是否可以通过某种方式告诉NSwag生成结果 swagger.json ，以字母顺序显示操作?

Is it possible to somehow tell NSwag to generate resulting swagger.json showing operations in alphabetical order?

推荐答案

UI配置中有选项.您需要做的就是在您的 Startup.Configure 方法中使用 OperationsSorter 和 TagsSorter ，例如:

There is option within UI configuration. All you need is utilize OperationsSorter and TagsSorter, within your Startup.Configure method like:

app.UseSwaggerUi3(a => {
    a.OperationsSorter = "alpha";
    a.TagsSorter = "alpha";
});

这篇关于如何通过控制器名称对NSwag swagger.json中的路径进行排序/排序的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！