-
Notifications
You must be signed in to change notification settings - Fork 269
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.
Already on GitHub? Sign in to your account
Accordions? #28
Comments
Yep great work, but I have the same issue. Perhaps a left hand navigation like this (and others) use would be good: http://swaggerui.herokuapp.com/ |
Wanted to share an update on this issue:
|
release you are welcome to provide feedback |
I realize that this issue is closed, but I thought I'd provide some of that feedback that you asked for. First, I think it's pretty slick to be able to view the API by tag or by path. I have some comments, based on my role as a writer and information designer:
I'm going to agree with @dagnelies original suggestion that some form of vertical expanding/collapsing would provide a better user experience for larger APIs. The "path" view has value, but it's not the equivalent of expand/collapse. One of the limitations of Swagger UI is poor navigation, and expanding/collapsing sections is a huge help in tools that provide that. Granted that the left navigation in "tag" view is based on optional fields, but I think it's okay to say that RapiDoc produces better and more useful output when the source material contains more information. If a method doesn't have a tag, RapiDoc could put that in an "Other" section. RapiDoc doesn't create information -- it just makes it pretty. :-) You said that fields used to create the left-column navigation can contain Markdown, but I don't think that's true for just tag names, is it? I think those can only be text. It's the tag descriptions that can contain Markdown. |
I agree with @StephenNay ...it's not optimal on the right. IMHO, I would place the HTTP Verbs in a fixed size column on the left, like this:
...most of us developers working with REST APIs often do so on desktops with big screens and not on smartphones. Therefore, IMHO taking up some space should not be an issue. what I think might further slightly improve readability is to highlight the last part of the path, like this: /resource |
sorry about commenting late on this, I missed the comments since the issue was in closed state. The "Group By Path" option introduced in |
Hi,
First, thanks for this theme 馃憤
Once the API grows a bit, it becomes a large list of operations, which is "uncomfortable" to navigate quickly.
IMHO it would be nice to tag sections expandable/collapsible (like swagger ui for example). This would make navigation much more easy.
The text was updated successfully, but these errors were encountered: