Challenge Overview
-
Create Swagger and Mock API for the given designs which will help during prototype development
Project background
-
Our client is looking to create a marketplace for commonly used APIs which can be used by financial institutions like banks
Technology Stack
-
Open API 3.0 (a.k.a Swagger)
-
Node.js 10.x
-
Lowdb (JSON Database)
Challenge Assets
-
Marvel app link is shared in the challenge forum
-
Existing Mock API code is shared in the challenge forum
Individual requirements
Update Swagger
-
For the given marvel app, update swagger with new end points for each and every functionality in the design following the best practices of Swagger
-
Swagger editor can be used to validate the Swagger being created
-
Please pay attention to best practices of Swagger like reusable parameters, headers
Update Mock API
-
Extend existing Mock API following the specifications in updated Swagger
-
Mock API should persist the data. All endpoints should be functional. Search, filter, pagination is expected to work in GET end points. POST and PUT end points should persist data in the JSON database.
-
401 status code is handled by the authenticator present in the existing codebase and 403 is not bothered right now. 404 and 409 status codes are expected to work.
-
Please pay attention to the comments given in marvel screens with annotations
UI to API Mapping document
-
Please prepare a UI to API mapping document in word format which will help prototype developers to connect each page with appropriate API endpoints
Scoring Criteria:
-
We will be using Subjective score card for this challenge
-
How accurately Swagger captures the functionalities in design
-
How accurately Mock API produces response in line with Swagger
-
How accurate UI to API mapping document is
Important Notes:
-
Submission, Review, Appeals timeline for this challenge is shorter than usual. Please pay attention to the shortened timelines
-
Please pay attention to the comments in marvel app
-
Please ensure that you are following best practices of Swagger and there are no lint errors in Mock API code
-
If you have any doubts, Please feel free to post it in the forum. We will be happy to resolve your queries as soon as possible.
Final Submission Guidelines
-
Zip your updated codebase and submit the zip file using the submit link in the challenge.
-
After submitting, please ensure that you are able to download your submission from Online Review