Not rendering with $refs

[thardy]

Not rendering with $refs

[thardy]

That did it! Thank you!

[dylthedev]

If you have refs in your yaml, those will be loaded into your JSON.
You need to use something between loading the yaml file and serving the JSON to resolve the references in the JSON, js-yaml doesn't do that.
Something like json-refs would.

In your particular use case, this should work

import jsonRefs from 'json-refs';
// ...

// setup our swagger page
const openApiSpecPath = path.join(__dirname, '..', 'docs', 'open-api.yml');
const openApiSpecFile  = fs.readFileSync(openApiSpecPath, 'utf8');
const swaggerDocument = yaml.load(openApiSpecFile);

const resolvedSwaggerDocument = await jsonRefs.resolveRefs(swaggerDocument, {
    location: openApiSpecPath,
    loaderOptions: {
        processContent: function (res, callback) {
            callback(yaml.load(res.text)); // this callback is required to resolve those JSON references 
        }
    }
});

app.use('/api/swagger', swaggerUi.serve, swaggerUi.setup(resolvedSwaggerDocument.resolved));

Note you might not be set up properly to use top level await, so you may have to create your own async function.