Skip to content

Commit

Permalink
Disable validator by default and add description comment
Browse files Browse the repository at this point in the history
  • Loading branch information
nichwall committed Aug 4, 2024
1 parent 0585f81 commit 7ba243a
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions server/Server.js
Original file line number Diff line number Diff line change
Expand Up @@ -205,12 +205,15 @@ class Server {
})

// Install the OpenApiValidator middleware if using a dev environment
if (Logger.isDev) {
// If you do not want to use this, you can comment out the entire section
// or only certain parts.
if (Logger.isDev && false) {
// This is a solution to validate the API responses, but is a work in progress.
// By default, this is disabled because invalide API requests or responses can cause
// crashes in the web client while developing other parts of the application.
//
// The default value of `validateResponses` is false, so it can be safely commented
// out if the validation is causing problems.
// The OpenAPI spec is still a work in progress.
//
// If you would like to only validate responses or requests, you can adjust the
// `validateRequests` and `validateResponses` options accordingly.
const apiSpec = Path.join(__dirname, '..', 'docs', 'openapi.json')
app.use(
OpenApiValidator.middleware({
Expand Down

0 comments on commit 7ba243a

Please sign in to comment.