We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Hi,
swagger-jsdoc doesn't generate the documentation for files in "deep" directories. I don't know if it's a bug from glob or swagger-jsdoc.
swagger-jsdoc
Here is my file structure :
. |- scripts/ | | - src/ | | | | - controllers/ | | | | | | - projects/ | | | | | | | | - index.js | | | | | | - index.js
I have added commands in my package.json file
package.json
"doc": "swagger-jsdoc -d scripts/swaggerDef.js -o ../documentation/public/swagger.json ./src/**/*.js", "doc:watch": "yarn run doc -- -w"
And here is my swaggerDef.js file :
swaggerDef.js
const packageJson = require('../package.json') const tagNames = 'blueprint invitation notification org ' + 'project-tag user project task' const tags = tagNames .split(' ') .map(name => { return { name, } }) module.exports = { info: { title: 'Clovis API', version: packageJson.version, description: 'Official Clovis API documentation.', }, host: 'localhost:3009', tags, }
When I run swagger-jsdoc only src/controllers/index.js is processed, not src/controller/projects/index.js
src/controllers/index.js
src/controller/projects/index.js
I run the yarn run doc from the root of my project.
yarn run doc
The text was updated successfully, but these errors were encountered:
Any answers ? Thanks a lot for your help @chdanielmueller @kalinchernev @devlouisc @fliptoo ;)
Sorry, something went wrong.
No branches or pull requests
Hi,
swagger-jsdoc
doesn't generate the documentation for files in "deep" directories. I don't know if it's a bug from glob orswagger-jsdoc
.Here is my file structure :
I have added commands in my
package.json
fileAnd here is my
swaggerDef.js
file :When I run
swagger-jsdoc
onlysrc/controllers/index.js
is processed, notsrc/controller/projects/index.js
I run the
yarn run doc
from the root of my project.The text was updated successfully, but these errors were encountered: