serve swagger-ui through the swagger-ui-dist; v2 #39
Conversation
| tap-snapshots | ||
| test | ||
| .travis.yml | ||
| var |
There was a problem hiding this comment.
yes, I can, but, I wanted static to be ignored by git while be included in the npm. I see it's only possible with adding .npmignore.
plus I think that it's not really needed to include tests and other stuff into the package itself.
what do you think?
package.json
Outdated
| @@ -4,7 +4,9 @@ | |||
| "description": "Generate Swagger files automatically for Fastify.", | |||
| "main": "index.js", | |||
| "scripts": { | |||
| "test": "standard && tap test/*.js" | |||
| "prepare:swagger-ui": "node var/npm/prepare-swagger-ui", | |||
There was a problem hiding this comment.
can you use prepublish instead? https://docs.npmjs.com/misc/scripts.
routes.js
Outdated
| method: 'GET', | ||
| schema: { hide: true }, | ||
| handler: sendStaticFiles | ||
| // server swagger-ui with the help of fastify-static |
There was a problem hiding this comment.
typo, it should be "serve swagger-ui with the help of fastify-static".
| @@ -43,28 +28,15 @@ function fastifySwagger (fastify, opts, next) { | |||
| url: '/documentation', | |||
| method: 'GET', | |||
| schema: { hide: true }, | |||
| handler: (request, reply) => reply.redirect(request.raw.url + '/') | |||
| handler: (request, reply) => reply.redirect('./documentation/') | |||
There was a problem hiding this comment.
Why the dot in './documentation/'?
There was a problem hiding this comment.
so my case was the next, I serve my service under the reverse-proxy, like:
/service points to the service itself, let's say localhost:3000.
With the previous version, when I was visiting /service/documentation it was redirecting me to the /documentation/. With the current version it works fine.
Here how I've checked it:
'use strict'
const fastify = require('fastify')()
const proxy = require('fastify-http-proxy')
fastify.register(require('../index'), {
mode: 'static',
specification: {
path: './examples/example-static-specification.yaml'
},
exposeRoute: true
})
fastify.register(proxy, {
upstream: 'http://localhost:3000/',
prefix: '/upstream/' // optional
})
fastify.listen(3000, err => {
if (err) throw err
console.log('listening')
})(put to the script into examples, install fastify-http-proxy, open http://localhost:3000/upstream/documentation)
var/npm/prepare-swagger-ui.js
Outdated
| @@ -0,0 +1,39 @@ | |||
| const fs = require('fs') | |||
There was a problem hiding this comment.
Just for curiosity, why create this folder structure and not a simple script in the root of the project?
There was a problem hiding this comment.
I like to have the root clean, since usually in the modern web project there are already a lot of dot files out there.
So usually I have:
src(for the code, which sometimes get compiled into thedist)var(for all the various files such as build scripts, images for the readme, etc.)- maybe
__tests__
And that's all.
There was a problem hiding this comment.
Since it is just one file you can leave it inside the root folder, it is not our common practice use the var folder and this could lead to confusion :)
package.json
Outdated
| "test": "standard && tap test/*.js" | ||
| "prepare:swagger-ui": "node prepare-swagger-ui", | ||
| "test": "standard && tap test/*.js", | ||
| "prepublish": "npm run prepare:swagger-ui && npm test" |
package.json
Outdated
| }, | ||
| "dependencies": { | ||
| "fastify-http-proxy": "^0.2.1", |
There was a problem hiding this comment.
I guess fastify-http-proxy should be in devDependencies.
There was a problem hiding this comment.
sorry fastify-http-proxy should not be here at all, removed
|
can this be released? 🤗 |
|
Thanks! |
this is another variant of #37 .
preparing the
staticfolder before publishing the module (during the development needs to be done manually)