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

Question: Are there Plans to Upgrade to the Latest Swagger UI? #443

Closed
darahayes opened this issue Aug 1, 2017 · 9 comments

Comments

Projects
None yet
7 participants
@darahayes
Copy link

commented Aug 1, 2017

Firstly, thanks so much for your module. We use it a lot at our company and are very hapi with it (sorry for the terrible pun :)) That said I have a question about the Swagger UI version.

Currently hapi-swagger serves Swagger UI v 2.2.4, but is there any plan/initiative to update this to version 3.x?

I've made a fork of your repo here @darahayes/hapi-swagger and I've managed to get the plugin happily serving version 3.x.

I've published my own version of it so myself and my colleagues can use it straight away but I would love to hear your thoughts as to how we could merge this back into the original hapi-swagger module.

Is this something you would be interested in?

Cheers.

@aalimovs

This comment has been minimized.

Copy link

commented Aug 3, 2017

Seems work on the repo slowed down a bit with the last commit back in February 2017.

@glennjones hope you're doing well! I believe hapi-swagger became a crucial part of the hapi ecosystem. Is it worth looking at community getting involved to get it back to speed?

@darahayes

This comment has been minimized.

Copy link
Author

commented Aug 11, 2017

In the meantime, for anyone else coming across this issue. I would love to get your feedback on hapi-swagger-next. It's fork of this project and works as a drop-in replacement, but it delivers the latest Swagger UI.

I would love to see this module get updated and would be very happy to help.

@vmharrel

This comment has been minimized.

Copy link

commented Aug 15, 2017

@darahayes - Thanks for forking the project to add the latest updates. Did you include operationsSorter and tagsSorter to the list of options?

@darahayes

This comment has been minimized.

Copy link
Author

commented Aug 17, 2017

@vmharrel I've added those options here

I'll admit I haven't tested it out but the options are fed in the same way as in the old UI.

@glennjones

This comment has been minimized.

Copy link
Owner

commented Aug 20, 2017

Hi All, I am snowed under with work commitments at the moment and will be well into next year. So after keeping on top of hapi-swagger for 3/4 years things have slowed up.

Happy to have a look at new UI. Part of why I created this plugin was so that HAPI projects could sit side-by-side with .Net and Java projects using swagger. I think it’s important to add to upgrade for the same reason otherwise they will look dated.

I have a history in UX design and I am not sure I am happy with the new UI. I am thinking about an option to switch between version 2/3 of the UI. This has been difficult in the past as I have had to customise the SwaggerUI files to get everything to work. Looks like v3 maybe more flexible.

I am just doing a 12 PR update at the moment to get everything updated. Once v7.8.0. is released to NPM I will start on this.

In the long term handing this over community management my not bad thing. That is if anyone else is up for looking after it.

@jandockx

This comment has been minimized.

Copy link

commented Nov 17, 2017

@darahayes/hapi-swagger does not allow issues, sadly, but I thought I'd report here that it (^1.0.0) doesn't work for me. There seems to be a problem with Joi schemata:

2017-11-17T10:04:22.814Z, [response] http://localhost:3000: get /swagger.json {} 500 (19ms)
Debug: internal, implementation, error
    TypeError: Uncaught error: Converting circular structure to JSON
    at Object.stringify (native)
    at Object.internals.hasFileType (<PROJECT PATH>/node_modules/hapi-swagger-next/lib/paths.js:388:28)
    at routes.forEach (<PROJECT PATH>/node_modules/hapi-swagger-next/lib/paths.js:231:23)
    at Array.forEach (native)
    at internals.paths.buildRoutes (<PROJECT PATH>/node_modules/hapi-swagger-next/lib/paths.js:179:12)
    at internals.paths.build (<PROJECT PATH>/node_modules/hapi-swagger-next/lib/paths.js:151:17)
    at Object.builder.getSwaggerJSON (<PROJECT PATH>/node_modules/hapi-swagger-next/lib/builder.js:112:26)
    at handler (<PROJECT PATH>/node_modules/hapi-swagger-next/lib/index.js:117:29)
    at Object.internals.handler (<PROJECT PATH>/node_modules/hapi/lib/handler.js:101:51)
    at request._protect.run (<PROJECT PATH>/node_modules/hapi/lib/handler.js:32:23)
@mcorbe

This comment has been minimized.

Copy link

commented May 17, 2018

@glennjones any update on this side ? Any help needed ?

@robmcguinness

This comment has been minimized.

Copy link
Collaborator

commented May 2, 2019

UI is being upgraded in another branch 2bebc7a. Slowly working through to try an minimize the breaking changes.

@robmcguinness robmcguinness added this to the v10 milestone May 2, 2019

@robmcguinness

This comment has been minimized.

Copy link
Collaborator

commented May 26, 2019

Closed in v10.0.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.