Allow serving static assets from `baseDir`

davidjbng commented 9 months ago

Resolves #65

This PR documents how to serve static swagger-ui files from a custom directory and fixes serving static assets when the baseDir option is set.

Checklist

[x] run npm run test and npm run benchmark
[x] tests and/or benchmarks are included
[x] documentation is changed or added
[x] commit message and code follows the Developer's Certification of Origin and the Code of conduct

mcollina commented 8 months ago

@Fdawgs ptal

DavidTanner commented 8 months ago

Any idea on when this can be merged?

knolleary commented 7 months ago

I'm concerned this is a breaking change in behaviour and needs to be highlighted as such when it gets published - but would like a second opinion.

Prior to this change, if you set baseDir, the swagger static content would be served from the static folder included with this module. You could then set baseDir to point at another directory of content that should served in addition.

With this change, if you set baseDir it expects you to have copied the static folder included with this module into your baseDir.

So a working configuration prior to this PR will no longer work when this PR is applied.

fastify / fastify-swagger-ui

Allow serving static assets from `baseDir` #108

Checklist