Challenge Overview
Challenge Overview
We are building an internal web application for a client. This application is divided into frontend and backend. This will be a series of challenge to build both applications.
Goal of the challenge
The goal of this challenge is to build the first part of the backend.
Technology and Framework details
- Node.Js 12+
- NestJs
- Typescript
- Swagger
General Requirements
- Build the "provider-exchange-audience-api" as described in the documentation attached in the forum. The endpoints from 1 to 10 in the file Tech Spec BG5 Presentation API.pdf are in scope. Reports are not in scope of this challenge.
- The API does not make any access to a database. Instead it will make calls to the "provider-exchange-api". This API is not currently available so it's in scope to mock this API. The JSON responses will be provided in the forum as well.
- We don't have login in frontend but the API must be able to handle JWT. All endpoints must be made available with JWT present and valid. Please create hardcoded JWT tokens for validation and make the secret configurable.
- All configuration should be made using "config" package and must allow environment variables to be used.
- For POST endpoints, the mock api can just return success code.
- All needed documentation will be provided in the forum. Please make questions quickly to be able to complete the challenge.
- Swagger documentation is required. It must be made available under <api url>/docs/ path. Please describe success and failure cases:
- a few failure cases: Pagination with invalid values (negative values) - 400 code
- missing parameters for POST requests (assume all properties are required) - 400 code
- missing/invalid token - 401 code
- All business logic is provided in the documentation in the forum.
Final Submission Guidelines
- Backend source
- README with deployment and verification steps.