Saltar al contenido

Ordenar métodos API en Swagger-UI

Este team especializado pasados ciertos días de trabajo y recopilar de información, obtuvieron los datos necesarios, queremos que todo este artículo sea de gran utilidad en tu proyecto.

Solución:

Actualización para Swagger UI 2.1.0+: los sorter El parámetro se ha dividido en dos parámetros, como se indica en Fix 1040, Fix 1280:

clasificador apis

Aplicar una ordenación a la lista API/etiquetas. Puede ser ‘alfa’ (ordenar por nombre) o una función (consulte Array.prototype.sort() para saber cómo funciona la función de clasificación). El valor predeterminado es el pedido devuelto por el servidor sin cambios.

clasificador de operaciones

Aplicar una ordenación a la lista de operaciones de cada API. Puede ser ‘alfa’ (ordenar por rutas alfanuméricamente), ‘método’ (ordenar por método HTTP) o una función (consulte Array.prototype.sort() para saber cómo funciona la función de clasificación). El valor predeterminado es el pedido devuelto por el servidor sin cambios.

Así que querrás actualizar sorter a apisSorter para ordenar la lista de API alfabéticamente, y/o operationsSorter para ordenar la lista de operaciones de cada API. La demostración de la tienda de mascotas se ha actualizado a apisSorter, como se muestra a continuación:

Ejemplo: (demostración de trabajo, ordenada alfabéticamente)

window.swaggerUi = new SwaggerUi(

...

apisSorter : "alpha"
);

Para versiones de Swagger UI anteriores a 2.1.0:

los sorter El parámetro sigue siendo relevante para versiones anteriores de la interfaz de usuario de Swagger:

Puedes usar el clasificador parámetro al instanciar SwaggerUi. Esto sucede en el javascript en Swagger-Ui index.html. De la documentación:

sorter aplica una ordenación a la lista de API. Puede ser ‘alfa‘ (ordenar rutas alfanuméricamente) o ‘método‘ (ordenar operaciones por método HTTP). El valor predeterminado es el pedido devuelto por el servidor sin cambios.

Ejemplo:

window.swaggerUi = new SwaggerUi(

...

sorter : "alpha"
);

La respuesta aceptada está un poco desactualizada. En versiones más nuevas se hace mediante:

window.swaggerUi = new SwaggerUi(

...

apisSorter: "alpha", // can also be a function
operationsSorter : "method", // can also be 'alpha' or a function
);

// I had the same issue and i fixed like this 
window.swaggerUi = new SwaggerUi(
    apisSorter: "alpha", 
    operationsSorter: function (a, b)  
    var order =  'get': '0', 'post': '1', 'put': '2', 'delete': '3' ; 
    return order[a.method].localeCompare(order[b.method]);    
  ,
);

Aquí puedes ver las reseñas y valoraciones de los usuarios

Si para ti ha resultado de ayuda nuestro artículo, te agradeceríamos que lo compartas con más programadores de esta manera nos ayudas a difundir nuestra información.

¡Haz clic para puntuar esta entrada!
(Votos: 0 Promedio: 0)



Utiliza Nuestro Buscador

Deja una respuesta

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *