api and method listing order in JAX-RS

[fehguy]

The resource listing seems to present apis in random order, and api listing resource shows operations in random order as well. Best if they can be maintained if possible

[sibblegp]

Indeed. This is very important for structure.

[shawnlauzon]

+1 Really annoying that there isn't any order to this.

[engrun]

+1
I would also like to see a feature where you configure the ordering/listing in blocks based on the path
Example, we have two structures
/internal/../onlyToBeUsedByTheMyCompany
and
/external/../openAndPartnerRelatedApis

So, here, preferable, I would like to have two listing/blocks, one for all starting with /internal and one for /external

[fehguy]

I'm having a hard time reproducing this. There are two different parts to this issue:

1. The UI honoring the JSON being returned for both APIs and operations
2. The generation of the JSON from server frameworks

I'm seeing both working fine with 1.2.1. Can someone please point to an example where this is not the case? Or am I just getting lucky with the order?

A more complicated example is here:

http://developer.wordnik.com/docs.html

[sibblegp]

I'm actually not having this issue. It does appear to respect the order of APIs and such presented.

[engrun]

Hmm. I now believe that the use of JRebel is causing the random ordering, i.e the ordering changing upon page refreshes.

However, @sibblegp writes " It does appear to respect the order of APIs and such presented."
What exactly is the order of API's listed? What can I expect the ordering to be?
Is clearly is neither alphabetically, the package/class hierachy, the path defined in @Api nor the order in which the methods are defined in the resource-classes.

[fehguy]

@engrun should be the order "presented in the JSON" from the server, for instance http://petstore.swagger.wordnik.com/api/api-docs.json/pet

The good news is the random ordering appears to be based on the server loading & inspection of the classes, not the swagger framework, which is a "one-time" process, which means we can expose a sort function to allow you to order them however you like. Not sure what the best interface would be to do that, but it should be simple.

[shawnlauzon]

I just grabbed master; with my classes annotated with JAX-RS, the order of operations is somewhat random. However, it doesn't change when the page is reloaded.

[fehguy]

@shawnlauzon can you look at the JSON generated by the server? My guess is that is changing on restarts of the app. Take a look at both the resource listing and api declaration

[shawnlauzon]

Actually they look exactly the same. It's odd: there is some structure since all of the operations with the same path are grouped together, but the order of those groups are not according to any structure I can see.

[engrun]

If you can add a configurable sorting, that would be great!

I have added some screenshots to illustrate the ordering-problem.

Here you can see the very first request for the swagger UI

The listing looks like this

After a page refresh in my browser

So, for me there a two problems

1. The UI is not ordering properly on the first request and after server restarts. A page refresh seems to fix it

2. The listing is always sorted in some way (although I can't seem to figure out the logic behind the sorting), and this sorting is always the same

[engrun]

In the screenshot, you can see that, under "/herd" , the methods are not ordered alphabetically, as "youngstockdistribution" is listed before "taxHerdOverview"

[Zambiorix]

Why is this closed? What is the solution? How do I influence the sort order?