#162727461 Document api with swagger #21
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
setup swagger configuration use swagger jsdoc in authrouter [Delivers #162727461]
abejide001
requested review from
daniellamarr,
andela-dbamidele,
julietezekwe and
wombolo
and removed request for
daniellamarr
| authRouter | ||
| .post('/signup', | ||
| UserValidator.UserSignUpValidator, | ||
| emailCheck, | ||
| UserController.signUp); | ||
| /** | ||
| * @swagger |
There was a problem hiding this comment.
Please, I would like to know if there is a reason for using swagger JSDOCs against Swagger.json where the documentation is kept in a different file. I feel using swagger.json file and having all the documentation there is cleaner because adding documentation to the route file will make it unavoidably long and I don't think we want that. Anyone going through the route file will have to read the doc of each of them.
There was a problem hiding this comment.
This approach works fine for our project, because the controllers have separate route files, for reference purposes please check here https://github.com/Surnet/swagger-jsdoc/blob/master/example/v2/routes.js
julietezekwe
approved these changes
Jan 21, 2019
andela-dbamidele
approved these changes
Jan 22, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Document application API with swagger
Description of Task to be completed?
localhost:9000/api/v1/api-docsHow should this be manually tested?
npm ilocalhost:9000/api/v1/api-docs, and make request to any endpointAny background context you want to provide?
N/A
What are the relevant pivotal tracker stories?
#162727461
Screenshots (if appropriate)