Support to hide tags, endpoints and/or operations from the UI

[peterhoogendijk]

I'm looking for a way to hide a complete tag, an endpoint, or an endpoint method from the generated api-doc (so also from swagger-ui). The implemented endpoints paths and methods should still be available in the api itself. Looking in the docs, the @hidden annotation seems to offer this functionality, but decorators are not allowed in the scripts I'm implementing.

If there already is an option to do this in express-openapi, please document this and optionally provide an example in the test suite. If this is not yet supported by express-openapi, please consider implementing this option.

[jsau-]

So from memory the way I've achieved this before is adding a custom property, e.g. x-hidden, to a specific endpoint, and then using the securityFilter function to filter out any endpoints on apiDoc which have that property set.

Very very basic pseudocode below (apologies, don't remember the specific structure of apiDoc off the top of my head). Can give a more concrete example later if you're still wanting some help! 👍

e.g.

Endpoint:

POST.apiDoc = {
   /* ... */
   description: ‘…’,
   operationId: ‘…’,
   ‘x-hidden’: true,
};

Initializing the OpenAPI service:

initialize({
  /* ... */
  promiseMode: true,
  securityFilter: async (req, res) => {
    req.apiDoc = somehowMutateThisToHideWhatYouWant();
    res.status(200).json(req.apiDoc);
  }
});