python - Swagger-ui 中参数的排序

Question

我正在使用 Flask 和 Flask-restplus 构建一个带有 swagger UI 的 API。 路由似乎是按字母顺序显示的，但至于这些路由的参数，它们似乎是以完全随机的顺序显示的，每次我重新构建项目时都会改变。

我已经彻底搜索了一种设置参数在 UI 上出现的顺序的方法，但我没有找到任何东西(我预计很多人都会有同样的问题)。

有没有办法设置参数的顺序？

Answer 1

您需要使用操作排序器并编写自定义排序函数。这是一个例子:

// dist/index.html

const ui = SwaggerUIBundle({
url: "http://petstore.swagger.io/v2/swagger.json",
...

operationsSorter: (a, b) => {

        var methodsOrder = ["get", "post", "put", "delete", "patch", "options", "trace"];

        var result = methodsOrder.indexOf( a.get("method") ) - methodsOrder.indexOf( b.get("method") );
      // Or if you want to sort the methods alphabetically (delete, get, head, 
      options, 
      ...):
     // var result = a.get("method").localeCompare(b.get("method"));

      if (result === 0) {
       result = a.get("path").localeCompare(b.get("path"));
      }

   return result;
  }
})