Skip to content
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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use Bootstrap frontend framework #1250

Closed
dmyers opened this issue May 8, 2015 · 22 comments
Closed

Use Bootstrap frontend framework #1250

dmyers opened this issue May 8, 2015 · 22 comments
Milestone

Comments

@dmyers
Copy link

dmyers commented May 8, 2015

What do you think of using the Bootstrap frontend framework for Swagger UI?

I think it would make it easier to style as there are themes and variables you can use that would allow for easier customization of Swagger UI.

@jensoleg
Copy link

I have ported a bootstraped responsive layout to swagger UI. Check out the github fork

This is an example
Resp example 1

.. and on small size window

Resp example 1

You can check it here by entering a link to your own api swagger file

@dmyers
Copy link
Author

dmyers commented May 13, 2015

@jensoleg That looks amazing! I'm incredibly impressed, nice work. It looks very much like Stripe and Slate which I'm a big fan of. It looks to even have most of the Swagger UI functionality too like response schema/sample/codes and everything too and really fully featured. I hope this could be potentially brought into core, I really like Swagger and that design is much easier to digest and read than the current UI. 👍

I'm going to play around with that, only thing I can think that might be a nice addition is OAuth for my needs, but I'm still unsure since I want to eventually support multiple grant types and the current UI just supports implicit authorization redirect I believe. I like how Auth0 when you click Try it pops up that modal and asks for the credentials, rather than the current Swagger UI has the on/off switch, it's interesting UI/UX. Their scope picker is pretty nice too and could be used with OAuth grant types.

@who
Copy link

who commented May 13, 2015

@jensoleg Wow, impressive work! 👍

@RohanKumarBhoi
Copy link

@jensoleg i want to customize ur ui to provide sandbox within the response division and response schema within description part.But i am unable to figure it out.Need Help....

@jensoleg
Copy link

@RohanKumarBhoi I'm not quite sure what your intention is. If you want to customize the UI you have to modify the handlebar templates / css and eventually the view js files. If you want to apply new layout to the response/schema you should look at swagger-client file. Be aware that the response sample and schema are rearranged when resizing the device/browser. It is not obvious how a rearrangement of the response sample/scheme will influence the current responsive design.

@RohanKumarBhoi
Copy link

@jensoleg Thanks for the help.I think i'm getting it and able to modify and reposition some of the stuffs

@webron webron added this to the future milestone May 28, 2015
@webron
Copy link
Contributor

webron commented May 28, 2015

Thanks for opening the ticket (@dmyers) and sharing the implementation (@jensoleg).

We're definitely looking into an overhaul, but can't give specifics (not hiding them, they just don't exist yet). This kind of feedback is helpful for the planning.

@zachguo
Copy link

zachguo commented Jun 4, 2015

@jensoleg Impressive. 👍

@Smolations
Copy link

While I like the idea of using a known framework, I would opt for Google's Material Design instead of Bootstrap. That would be my vote. =]

@ddaguro
Copy link

ddaguro commented Jun 23, 2015

@jensoleg This is awesome! We love it!

@mukgupta
Copy link

mukgupta commented Jul 9, 2015

@jensoleg: Thanks for this. Looks much better than the original UI

@wing328
Copy link

wing328 commented Jul 10, 2015

@jensoleg 👍

@felipemarques
Copy link

@jensoleg
image

@mavencode01
Copy link

+1

2 similar comments
@konczak
Copy link

konczak commented Feb 25, 2016

+1

@mvarblow
Copy link

mvarblow commented Apr 7, 2016

+1

@Misiu
Copy link

Misiu commented Apr 13, 2016

@wing328 any news on this? Many of us would like to help with "refreshing" ui.

@wing328
Copy link

wing328 commented Apr 13, 2016

@Misiu is this task assigned to me??

@Misiu
Copy link

Misiu commented Apr 13, 2016

@wing328 sorry for that, I wanted to mention @webron because he wrote that team is considering new UI on 28'th May 2015.
@jensoleg version looks great, maybe team considers making official new UI based on it?

@webron
Copy link
Contributor

webron commented Apr 13, 2016

@Misiu we're not, but there may be some news on that front in a couple of months. These things take time.

@cnmuc
Copy link

cnmuc commented Apr 16, 2016

@jensoleg great work! looking forward to a stable version...

@webron
Copy link
Contributor

webron commented Mar 20, 2017

We've just published 3.0. It's not based on Bootstrap, but React, still allowing for more customization.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests