Challenge Overview
Context
Challenge Context
Welcome to the "Metadata Editor App - Backend API Design Challenge". We are building a new web application for a client. This application will be divided into frontend and backend. In the previous challenge, we got UI design (https://www.topcoder.com/challenges/30127937). In this challenge, we are going to design the backend API.
Project Context
Make my large number of tags manageable in bulk.
We are looking for an application where data users can view and edit existing metadata fields. The database is a relational database, similar to what sits on the backend of classifieds websites such as Craigslist/Gumtree. Administrators need to be able to find items within the database using a search function along with filters to narrow down relevant results. Results are then selected, with the metadata editor opened up to make changes to the assigned tags - the functions incorporated into the metadata editor should be the primary focus of the challenge.
Expected Outcome
- Swagger OpenAPI 3.0
- Document the relations of backend responses and database models
- Document how to integrate frontend and backend API
Challenge Details
Development Assets
- UI Design
- DB schema
Individual Requirements
- We need to design backend API with OpenAPI in YAML format. List of API which should be included in build:
- Adding objects (Tables and columns)
- Adding Tags on objects
- Adding Expert information on object
- Other endpoints needed for frontend
- DB schema is provided in the forum. Please try to understand its structure. Do not change any schema. If you find current db is impossible to implement backend to support frontend, please ask in the forum.
- UI design url is provided in the forum.
- Document the relations between database model and backend response
- Document for each UI page and each operation, which API endpoints are used.
Final Submission Guidelines
- One yaml file for API spec in OpenAPI format
- Two docs or PDF files