Mentorship-backend: Beautify/Format Swagger.json

[Shivansh2407]

Is your feature request related to a problem? Please describe.
The Swagger.json page seems to be a bit congested. In order to make it look better we can try to beautify the json file, and present it in tree view format.
You can take a look at the idea in the link : https://codebeautify.org/jsonviewer

Additional context
Please comment below to get the issue assigned to you. This is a part of OSH and hence will be assigning it on First come first serve basis

[kritikaparmar-programmer]

I want to work on this issue.. Please assign me..

[Shivansh2407]

Go ahead @kritikaparmar-programmer 👍

[kritikaparmar-programmer]

Hey @Shivansh2407 , I looked for the Swagger.json file but it was deleted by someone 5 days ago..
Can you please take a look and correct me if I'm wrong..

[Shivansh2407]

But I guess, it is available at the heroku app at the /swagger.json endpoint. You need to just beautify it and display the formatted json view on the same endpoint.

[kritikaparmar-programmer]

Hey @Shivansh2407 , I setted up the project locally and when I run it I found the file on the webpage and even I know how to beautify it but I am having confusion on where and how to edit the file that in the project like how to display the formatted json view on the webpage.
Can you please help me with this..

[Shivansh2407]

Hi @kritikaparmar-programmer , you can create a template for the same and display it in the /swagger.json endpoint.

[SanketDG]

The swagger.json endpoint is generated by flask-restx, I am not sure how much it can be overridden.

[Anmollenka]

@Shivansh2407 Can I work on this issue?Thank You.

[Shivansh2407]

@Anmollenka this issue is assigned to @kritikaparmar-programmer . You can check out other issues as well.

[Anmollenka]

@Anmollenka this issue is assigned to @kritikaparmar-programmer . You can check out other issues as well.

I would like to work on this when it is free.

[priyanshuone6]

Hey, can you please assign this issue to me when it's free

[khushishikhu]

may i work on this issue

[SanketDG]

Anyone who wants to work on this issue, please provide a little roadmap of what you want to achieve, I think this issue has a large scope of what can be done, and even can be done as its own mini project.

[khushishikhu]

@SanketDG do we need to format json file also in tree view format, like this in screenshot

[SanketDG]

@khushishikhu Yes. Not strictly, but I am guessing @Shivansh2407 has more views on this.

[khushishikhu]

@Shivansh2407 please give me your views about the json file sholud look like this in screenshot and also which do have to beautify?

[Shivansh2407]

Yes @khushishikhu , The screenshot you've attached is what I wanted the swagger.json to look like. But the main thing here is that we need to change/update the endpoint with this tree view to make it more readable, i.e. /swagger.json . For this you need to figure out on how it can be done as the endpoint is generated by flask-restx. If you need any help do let us know 👍

[khushishikhu]

@Shivansh2407 can you please give me some reference i can look for on how to make swagger.json in tree view format.
As i am completely new to this

[Shivansh2407]

Yeah Sure @khushishikhu , Please have a look at the links/resources :
https://ourcodeworld.com/articles/read/753/creating-collapsible-tree-structures-from-json-into-html-in-javascript
https://www.cssscript.com/json-data-tree-view/
Assigning this issue to @khushishikhu , unassigning @kritikaparmar-programmer due to inactivity 👍

[khushishikhu]

@Shivansh2407 does it needs to be like this as i have just rendered the JSON data into HTML in javascript in the form of tree view. right now i have made changes in some of its part. just to make sure if i am doing right
please have a look

[khushishikhu]

hey @Shivansh2407 i guess i think that this issue has been resolved, because now i have checked swagger.json file it is showing me in tree format

[devkapilbansal]

@vj-codes @rpattath as swagger.json file has been removed now. Is the issue and linked PR valid?

[vj-codes]

@devkapilbansal although the file is deleted, the swagger.json endpoint is still there on the heroku link . If there is a need to beautiful that endpoint, a new issue cn be created and these could be closed. What say?

[devkapilbansal]

@devkapilbansal although the file is deleted, the swagger.json endpoint is still there on the heroku link . If there is a need to beautiful that endpoint, a new issue cn be created and these could be closed. What say?

@vj-codes as far as I know, that endpoint is created by the flask-restx itself and it may be not be that easy too.
@SanketDG already had a discussion on it here :arrow_down:
https://github.com/anitab-org/mentorship-backend/pull/847#issuecomment-691432446

[vj-codes]

@devkapilbansal it's best to close the PR and issue then:)