Skip to content
New issue

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

v4 #117

Open
gabrielogregorio opened this issue Dec 22, 2022 · 1 comment
Open

v4 #117

gabrielogregorio opened this issue Dec 22, 2022 · 1 comment

Comments

@gabrielogregorio
Copy link
Owner

import docbytest from 'docbytest';

const docbytestJson = docbytest.generateDocs({
title:"",
description:"",
hiddenDevDocs: false,
folderDocTests: ["./src/test/"],
docFile: ["./docs"],
statusCodes: {
SUCCESS: {
code: 200,
description: 'ok',
},
SUCCESS_NO_CONTENT: {
code: 204,
description: 'no content',
},
}
});

// TO YOURS IMAGE
app.use(express.static('public'));

// TO RETURN DOCBYTEST
app.get(docbytest.config.routeDocbytestInfo, async (_req, res) => { // '/docs.json'
res.setHeader('Content-Type', 'application/json');
return res.send(docbytestJson);
});

// TO RETURN DOCBYTEST UI
app.use(docbytest.config.routeDocs, express.static(path.join(__dirname, docbytest.config.pathDocbytestUi)));

@gabrielogregorio
Copy link
Owner Author

return example on first start docbytest

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant