Paths Index
merravid opened this issue · comments
Using the cli tool, is it possible to generate a paths index before the individually detailed paths? This would be useful for users of the API to get a quick overview, especially for large and complex APIs.
If this functionality is not alredy available, I can have a go at implementing it.
What do you mean by path index? A ToC which shows the paths?
You can group paths by tags and then use swagger2markup.pathsGroupedBy = TAGS
Yes, a ToC of all the paths. Does .pathsGroupedBy achieve this?
Do you convert to AsciiDoc? Then there should be a ToC like this:
https://github.com/Swagger2Markup/swagger2markup/blob/master/swagger2markup-documentation/src/docs/asciidoc/images/Swagger2Markup.PNG
Yes I convert to AsciiDoc, then open the AsciiDoc in AsciiDocFX and convert to HTML.
I don't get the left TOC panel. I only get the main content. What am I missing?
@merravid to get table of contents u need to add :toc: argument to the document header. Then asciidoctor (or other software that supports :toc: argument) will generate it for you.
See https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/#table-of-contents-toc