Order of the REST APIs in api-docs and on UI

[Sahar]

Hi Tony,

What is the logic behind ordering the APIs in the documentation? Is it based on the order of the corresponding methods or is it based on the depth of the path in the @Path annotation? It seems to be ordering by depth first and then method. 

Thanks,

Sahar

[tony tam]

Hi Sahar,

For each @Api annotated resource, paths are grouped then sorted by position annotation value, if it exists.

[Sahar]

Thanks Tony, but what do you mean by "position annotation value"? Can you provide an example? thanks

[f.ter...@shaa.it]

Hi Sahar, if you take a look at the com.wordnik.swagger.annotations.Api class (the one associated with the @Api annotation) you can see a "position" property, used to set the ordering of the api in the resources listing.

[tony tam]

Yes--as mentioned above, see here:

https://github.com/wordnik/swagger-core/blob/master/modules/swagger-annotations/src/main/java/com/wordnik/swagger/annotations/Api.java