Swagger-UI 中的排序 API 方法

2024-06-29

我找不到任何工作示例,如何实现以下目标: 我希望 Swagger-UI 中的 API 方法按方法 (GET-POST-PUT-DELETE) 或/和按字母顺序排序。

到目前为止,所有方法都以随机顺序显示,甚至不是按照我的源代码给出的顺序。

我使用 Jax-RS + Jersey 1。

使用 @ApiOperation 的位置属性进行排序对我来说不是一种选择,因为方法太多,而且 API 仍在扩展,所以如果有新的方法,我需要更新所有方法。

有什么提示吗?


Swagger UI 2.1.0+ 更新: The sorter参数已分为两个参数,如中所述Fix 1040 https://github.com/swagger-api/swagger-ui/issues/1040, Fix 1280 https://github.com/swagger-api/swagger-ui/pull/1280:

apis分类器

对 API/标签列表应用排序。它可以是“阿尔法” (按名称排序)或函数(请参阅 Array.prototype.sort() 了解如何 排序功能有效)。默认是服务器返回的顺序 不变。

操作分拣机

对每个API的操作列表进行排序。它可以是“alpha”(按路径字母数字排序)、“method”(按路径排序) HTTP 方法)或函数(请参阅 Array.prototype.sort() 了解如何 排序功能有效)。默认是服务器返回的顺序 不变。

所以你会想要更新sorter to apisSorter按字母顺序对 API 列表进行排序,和/或operationsSorter对每个API的操作列表进行排序。宠物店demo已经更新为apisSorter,如下图:

Example https://github.com/swagger-api/swagger-ui/blob/master/src/main/html/index.html: (工作演示 http://petstore.swagger.io/,按字母顺序排列)

window.swaggerUi = new SwaggerUi({

...

apisSorter : "alpha"
});

对于 2.1.0 之前的 Swagger UI 版本:

The sorter参数仍然与旧版本的 Swagger UI 相关:

您可以使用sorter实例化 SwaggerUi 时的参数。这发生在 Swagger-Ui index.html 的 javascript 中。来自文档 https://github.com/wordnik/swagger-ui#swaggerui:

排序器对 API 列表进行排序。有可能 'alpha'(对路径进行排序 字母数字)或 'method'(按 HTTP 方法对操作进行排序)。 默认是服务器返回的顺序不变。

Example https://github.com/swagger-api/swagger-ui/blob/97ed093e6ec3a7a778ac6a41d76775c88b1fc951/src/main/html/index.html:

window.swaggerUi = new SwaggerUi({

...

sorter : "alpha"
});
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

Swagger-UI 中的排序 API 方法 的相关文章

随机推荐

  • 将未知格式的日期字符串转换为日期时间

    我正在构建一个通用自定义strToDatetime string 功能 日期字符串可能采用某些不同的格式 2 个最受欢迎的替代方案似乎datetime strptime string format and dateutil parser s
  • 大网格上的 QML 内存使用情况

    我开发了一款扫雷式游戏作为练习 QML 的一种方式 我遇到的问题是内存使用量会根据网格的大小而快速增长 gt 700 Mb 我将其大小设置为 150 150 较大的网格会导致崩溃 因为它是 win32 网格是这样构建的 其中的位来自使用 Q
  • Web服务客户端证书/身份验证最佳实践的解决方案

    我有一个简单的 Web 服务 有一个允许第三方开发人员访问的 API API 主要遵循 REST 原则 我对通过要求开发人员使用客户端证书来使 API 更加安全的解决方案感兴趣 是否有任何开源解决方案或其他实施建议可以帮助使用用户级证书进行
  • Rsync 制作平面副本

    我正在尝试编写一个脚本 将一个目录 带有子目录 的所有文件复制到另一个目录的根目录 所以想象一下我有这个文件结构 pic JPG PIC5 JPG FOLDER pic2 JPG pic3 JPG FOLDER2 pic4 JPG 我想要该
  • 使用 Pester 5 和 PowerShell 7 模拟类函数

    有谁有使用 Pester 5 和 PowerShell 7 模拟点源类函数的示例吗 谢谢 编辑 示例 类 MyClass ps1 class MyClass void Run Write Host Class Invoking run 我的
  • YouTube api 的永久访问令牌?

    我已经浏览了用于身份验证的 Oauth 和 AuthSub 方法的 google 文档 并且我尝试通过 google 搜索此内容 但没有结果 对于 Facebook 您可以请求长度为 的访问令牌lifetime 这意味着您不必每隔几周就请求
  • INSERT INTO 存储过程的输出

    我正在编写一个存储过程 首先在表中插入一个新行 然后 另一个查询需要此查询生成的 ID 是否可以使用 OUTPUT 访问预先生成的 ID 这就是我到目前为止所做的 这几乎是一个猜测 但没有成功 ALTER PROCEDURE dbo add
  • 如何在 TurboC 中启用链接浮点库?

    我是C语言新手 只是想问一下如何在TurboC中启用链接浮点库 来自comp os ms dos programming 常见问题解答 http www faqs org faqs msdos programmer faq part2 se
  • 使用 Get2D 访问 OpenCV 中的 2d 像素值时出现超出范围错误或错误的返回值

    这是一个简单的程序 使用 OpenCV Python 中 导入图像 将其转换为灰度并将其显示在窗口中 然后 当用户单击窗口中的某个位置时 将从该点开始执行洪水填充 此外 当用户单击该点时 程序应打印该位置的原始 2D 像素值 不幸的是 当过
  • 目标 C:检测震动

    我正在使用 shake api 如下所示 void motionEnded UIEventSubtype motion withEvent UIEvent event if event subtype UIEventSubtypeMotio
  • 通过 Devise 将 Discourse SSO 与现有 Rails 站点相结合

    我有一个现有的 Rails 应用程序 它使用 devise 作为用户身份验证 我添加了一个话语论坛 http www discourse org一切都很顺利 它驻留在子域上 我已阅读该帖子https meta discourse org t
  • 继承的构造函数的 C++ 可见性[重复]

    这个问题在这里已经有答案了 当我使用using这样为什么构造函数要公开继承呢 class Base int x public Base int x class Derived public Base using Base Base 我现在可
  • Live555 的抖动单元

    我正在浏览一些使用 Live555 作为底层网络层的 VoIP 软件的文档 按照RFC https www rfc editor org rfc rfc3550对于RTSP live555似乎已经实现了它 但输出对我来说并不清楚 来自Liv
  • 在 C++ 中调用 fortran 子例程时出现分段错误

    我正在尝试用 C 调用 Fortran 子例程 这是子程序的开始 subroutine fireballess ear ne parames ifl photar photer integer ne ifl real 4 ear 0 ne
  • Pandas 删除时间范围之外的行

    我试图遍历 DataFrame 索引中的每一行并删除不在特定时间之间的所有行 我一直在寻找解决方案 但它们都没有将日期与时间分开 我想做的就是删除时间范围之外的行 您可以使用between time https pandas pydata
  • 我想将两个变量合并为一个具有日期格式的变量

    我有一个包含几个月的字符列的数据集 MONTH 和指示年份的数字列 YEAR 为了将其用作面板数据 我需要将这些结合起来YEAR and MONTH转换为日期格式的变量 我尝试过改变变量MONTH转换为数字格式 然后合并MONTH与柱YEA
  • 使用 Automapper 映射后,嵌套对象成员为 null

    我有一个对象 public class Tenant EntityBase public virtual string Name get set public virtual string Description get set publi
  • BoundedSemaphore 在 KeyboardInterrupt 上挂起在线程中

    如果在尝试获取信号量时引发 KeyboardInterrupt 则尝试释放同一信号量对象的线程将无限期挂起 Code import threading import time def worker i sema time sleep 2 p
  • Android 使用带有空格的键访问 Firebase

    这可能是一个愚蠢的问题 但我在谷歌的 firebase 网站上找不到任何示例 如果我在 firebase 数据库中有一个密钥 First Name 然后我打电话 FirstNameClass firstName dataSnapshot g
  • Swagger-UI 中的排序 API 方法

    我找不到任何工作示例 如何实现以下目标 我希望 Swagger UI 中的 API 方法按方法 GET POST PUT DELETE 或 和按字母顺序排序 到目前为止 所有方法都以随机顺序显示 甚至不是按照我的源代码给出的顺序 我使用 J