Challenge Overview
CHALLENGE OBJECTIVES
Welcome to “Best Practice - Swagger For Owner Web Endpoints Challenge”. In this challenge, we would like to create the Swagger documentation for the endpoints that will needed in an existing backend application.
Let us know in the forum if you have questions!
PROJECT BACKGROUND
Recently we've just finished the design for Owner web applications. Design Marvel App links:
- Owner web application design - https://marvelapp.com/b0ig660
The backend application is composed of 3 roles (Worker, Admin and Patient). At the moment only Worker and Patient roles were fully implement for existing web and mobile applications.
The Owner web application was completely refactored and it's used by Worker role.
REQUIREMENTS
- Using the design application above and the existing backend code, create a Swagger documentation for the endpoints that will be needed to support the web application. If an endpoint doesn't exists in backend please mark it as new in your submission.
- Existing swagger will be provided in the forum.
- Use the mongoose models in backend to create the Swagger file.
- Adjustments to the models might be needed (add/remove properties). Any doubts ask in forum.
- Swagger must be implemented in YAML format.
- No backend change is required in this challenge. We only need the Swagger documentation.
TECHNOLOGY STACK
The following technology stack will be used as part of this challenge.
- Swagger YAML
- Mongodb
Final Submission Guidelines
- Swagger file in YAML format