[ 
https://issues.apache.org/jira/browse/FINERACT-741?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17161521#comment-17161521
 ] 

Manthan Surkar commented on FINERACT-741:
-----------------------------------------

[~ptuomola] [~vorburger] [~sanyam96]

IMHO the current swagger-UI with the filter feature does a good job, and this 
feature can be enhancement but not a requirement for a swagger to operate. 
Having said that this is really good to have.

Currently swagger won't support this, but I have found something good enough to 
consider:
https://wll8.github.io/redoc-try/index.html
http://redocly.github.io/redoc/?url=https://demo.fineract.dev/fineract-provider/swagger-ui/fineract.yaml

Redoc does exactly what we want a sidebar, but I am afraid the project might 
not keep up with new features swagger generated JSON might have to offer. It 
does work with openAPI 3.0 file, but we need to make sure we get all important 
features like:*
1. Authorization
2. Try it out,
 work smooth, which might need some work.

TBH, I really like the sidebar but The general UI- swagger original is a bit 
neater.

If we can make all the features work + sidebar would you like to consider this? 
Given that it has some disadvantages as well?

The project is still very active:
https://github.com/Redocly/redoc

> Improving Swagger UI to group related APIs together instead of random order
> ---------------------------------------------------------------------------
>
>                 Key: FINERACT-741
>                 URL: https://issues.apache.org/jira/browse/FINERACT-741
>             Project: Apache Fineract
>          Issue Type: Sub-task
>            Reporter: Rahul Goel
>            Assignee: Manthan Surkar
>            Priority: Minor
>              Labels: fineract-swagger-doc
>
> All API's are currently listed in a random order and someone new to the 
> system cannot comprehend relationships between them. The home page needs to 
> be improved with either a sidebar or a navbar (similar to the one in the 
> existing documentation) which groups together related API's and provides 
> hyperlinks to their swagger documentation



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

Reply via email to