Proper way to ignore or exclude specific files from `apis`
iamgideonidoko opened this issue · 2 comments
Is your feature request related to a problem? Please describe.
It's a feature request. I understand that swagger-jsdoc
uses node-glob
for discovering input files based on given patterns but I should be able to specify files that I want to ignore from a pattern. Maybe by providing another option like ignoreApis
or honoring negative patterns (!).
Describe the solution you'd like
If I have a pattern for getting input files like this:
const option = {
apis: ['./src/routes/*.ts'],
};
I should be able to ignore or exclude a specific file that the pattern also matches like this:
const option = {
apis: ['./src/routes/*.ts', '!./src/routes/auth.route.ts'],
};
Describe alternatives you've considered
OR like this:
const option = {
apis: ['./src/routes/*.ts'],
ignoreApis: ['./src/routes/auth.route.ts']
};
Additional context
This is useful in a case like mine where I wan to exclude some routes from being documented on the prod server
Hi, here I have an example of how to build your files dynamically. You can have try to use it to build the specific routes that you want to https://github.com/daniloab/koa-crud-backend/blob/main/script/generateSwagger.ts
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.