server swagger-ui using the swagger-ui-dist module

[PavelPolyakov]

I've checked that in the old (current) version there is a bug regarding oAuth.
Probably it was already solved in the original swagger-ui/dist.

Regarding the permissions - let me know if I should put them back. Since I don't see any reason to have them 0755 and 0644 are from the original repo.

[mcollina]

How did you update swagger-ui? Can we use https://www.npmjs.com/package/swagger-ui-dist instead?

[PavelPolyakov]

@mcollina
I just copied over the files from the current master of the swagger-ui.
Actually in the current state of PR I forgot to serve new png files.

Yes, we can use dist as dependency, kind of I do it here:
https://github.com/PavelPolyakov/fastify-serve-swagger-ui/blob/master/src/index.js#L58

also it's possible to serve everything through fastify-static.

would you support integration with static + dist ?

[mcollina]

I think it’s a better approach. Il giorno ven 23 mar 2018 alle 19:49 Pavel <[email protected]> ha scritto:

…

@mcollina <http:///mcollina> I just copied over the files from the current master. Actually in the current state of PR I forgot to serve new png files. Yes, we can use dist as dependency, kind of I do it here: https://github.com/PavelPolyakov/fastify-serve-swagger-ui/blob/master/src/index.js#L58 also it's possible to serve everything through fastify-static. would you support integration with static + dist ? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#37 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AADL4zj2FoZHO1sgGJJyIZuLLtAB5aCAks5thUObgaJpZM4S47VT> .

[PavelPolyakov]

done as static + dist.

in my previous PR there was a bug for redirecting /documentation to /documentation/ when being served by the reverse proxy. So if you were calling /upstream/documentation it was redirecting you to /documentation/. Now should be fixed, tested with fastify-http-proxy.

since we are not storing static files anymore, I've removed the assertions which were testing the content.

this hook is a little bit strange as for me, since it will really listen for the all incoming requests. Let me know if you think there is better solution.

[mcollina]

this should not be needed, maybe fastify-static has a bug. Why do you need it?

[PavelPolyakov]

this is needed since I do not change the file from the original and content of swagger-ui-dist remains the same. But I hijack the request to the root or index.html and send our custom file instead of the default index.html.

[mcollina]

I don't think these prefixes are correct. I can mount this plugin with a given /swagger and it will add the ui as /swagger/documentation/.

A better approach would be to either have a post-install script or a prepublish  script where we do these changes and replacements. A prepublish might be better, because we can't guarantee that regexps are stable across versions. Why do we need those changes anyway?

[PavelPolyakov]

This changes needed because by default it index.html of the swagger ui leads to the pet store.
https://github.com/swagger-api/swagger-ui/blob/master/dist/index.html

I can mount this plugin with a given /swagger and it will add the ui as /swagger/documentation/.

how would you do that? I think prefix option is not supported.

I've tried this together with example/dynamic.js:

fastify.register(require('../index'), {
  swagger: {
    info: {
      title: 'Test swagger',
      description: 'testing the fastify swagger api',
      version: '0.1.0'
    },
    host: 'localhost',
    schemes: ['http'],
    consumes: ['application/json'],
    produces: ['application/json']
  },
  exposeRoute: true,
  prefix: '/swagger'
})

the documentation appeared on localhost:3000/documentation still.

a prepublish script where we do these changes and replacements.

you mean on prepublish we copy everything into our static folder and then serve it instead of the original swagger-ui-dist?

A prepublish might be better, because we can't guarantee that regexps are stable across versions.

Yes, the original html can be changed, but since the version is fixed, I think it's safe to rely on the regex.

[PavelPolyakov]

Here is the new variant #39

[PavelPolyakov]

closing since the other implementation won