[FEATURE REQUEST]: Swagger API Docs Task 1
simply-alliv opened this issue · comments
Is your feature request related to a problem? Please describe.
Documentation for the first employees endpoint (creating a new employee) is required.
Describe the solution you'd like
- Create documentation using swagger and jsDocs.
Describe alternatives you've considered
Not applicable
Additional context
None
@dave-ok In which folder should I create the jsDocs folder for the yaml files? Should it be in the src/ or src/api/ or somewhere else?
@simply-alliv Sorry it was an oversight. It was supposed to be in /api/v1/jsdocs. Thanks
I was trying to create the folder along with initial config for jsDocs, so the docs can be tested. I will wait till after your PR before pushing mine
@dave-ok Okay, great! I'll add the folder then. Another thing, should the address property of the employee object be another object with properties or?
And am I correct to assume that hireDate is a Date object? Or would it be like time in milliseconds?
@dave-ok Please do your PR first, I'm going to take a while. I'd like to test my code before I make a PR.