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

问题描述

我正在使用 NSwag 为我的 .NET Core api 生成 swagger 并且一切正常，除了渲染路径以便反射似乎从项目中拾取控制器.

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 文件夹)和一些在子文件夹(ControllersSubfolder 文件夹)中，那么顺序就会混乱.

So if I do have hierarchy - some controllers at root level (Controllers folder) and some in subfolder (ControllersSubfolder 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屋！