Swagger-ui with Swagger 2.0 - How to categorize apis

[Angeline Loh]

Hello,

I used the Swagger editor to write in YAML which then translate to JSON to be used in SwaggerUI. With the 2.0 definition, it looks great! One little thing I can't seem to find how to do is to have collapsible groups of routes. 

For example, in the pet example, it has 3 main categories - pets, users (and something else). How do you achieve this with a 2.0 compliant json schema?

THanks

[Ron]

That's done using the "tags" property for operations - https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#operationTags - it's an array of strings containing the groups you want to have for that operation.

The top-level "tags"- https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#swaggerTags- allows you to add additional metadata on the tags and control its UI ordering if you wish.

--
You received this message because you are subscribed to the Google Groups "Swagger" group.
To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggers...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[Angeline Loh]

Awesome. Works wonders.

Thanks heaps!

[Angeline Loh]

Hi,

Can I have multiple level tag nesting?

------

angeline loh

--
You received this message because you are subscribed to a topic in the Google Groups "Swagger" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/swagger-swaggersocket/qExwtPD_C1s/unsubscribe.
To unsubscribe from this group and all its topics, send an email to swagger-swaggers...@googlegroups.com.

[tony tam]

You can have operations under multiple tags, but not tags under tags.

[Angeline Loh]

I see. Can we break the yaml file into smaller yaml files and connect them together?

------

angeline loh

[Ron]

What exactly are you trying to achieve?

[Angeline Loh]

Sorry, it was actually another question not relating to the first. I have a growing yaml file, is it possible to "modularize" the documentation so to speak?

------

angeline loh

[Ron]

Technically, you can split the documentation, but I don't know if that's supported by the swagger-editor project yet. I'd suggest opening an issue on the repository and asking there.