[72 hrs] API Marketplace - Architecture and Mock API creation - Part 1

• 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

• json-server

Challenge Assets

• Marvel app link is shared in the challenge forum

• Design source file is shared in challenge forum as well

• Sample Mock API code which can be used as starter pack to develop this Mock API

Individual requirements

Create Swagger

• For the given marvel app, create swagger for each and every functionality in the design following the best practices of Swagger

• Swagger should be created in Open API Version 3.0

• Swagger editor can be used to validate the Swagger being created

• Please pay attention to best practices of Swagger like reusable parameters, headers

Create Mock API

• Create Mock API following the specifications in Swagger

• No need to create any database models, we will use json based lowdb which will be loaded with some meaningful mock data

• Please use the sample Mock API code shared in the challenge forum as a base to create this API. In search end points, filters need not work. If you follow the search techniques in existing code, pagination will work.

• Our focus is mainly on 200 and 400 status codes

• 401 status code is handled by authenticator present in sample code and 403, 404 and 409 status codes are not bothered now

• Please pay attention to the comments given in marvel screens with annotations

Scoring Criteria:

• How accurately Swagger captures the functionalities in design

• How accurately Mock API produces response in line with Swagger

Important Notes:

• Submission, Review, Appeals timeline for this challenge shorter than usual. Please pay attention to the shortened timelines

• 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