API documentation with OpenAPI/Swagger — endpoint descriptions, request/response
66
57%
Does it follow best practices?
Impact
100%
1.06xAverage score across 3 eval scenarios
Passed
No known issues
A small startup runs a platform where venues (conference rooms, event spaces) can be listed and booked. They have a Node.js/Express backend that currently has no API documentation, making it difficult for third-party integrators and the mobile app team to understand how to use the service.
You have been asked to build a clean Express REST API for the bookings domain and wire up interactive API documentation so that developers can explore and test the API from their browser without reading the source code.
The API needs to handle:
Error cases matter: the integration team has been burned before by undocumented failure modes, so documenting what can go wrong is just as important as documenting the happy path.
Implement the API in app.js (or split across files in a src/ directory — your choice). The entry point should export or start the Express app.
Produce a package.json with all dependencies listed.
Write a README.md that explains how to install dependencies and start the server, and includes the URL where the interactive API documentation will be accessible.
Do not start the server as part of this task — just produce the source files.