API Endpoint Creation
Main contact
Project scope
Categories
Information technology Software development DatabasesSkills
debugging data validation application programming interface (api) api gateway postgresql authorization (computing) api testing oauth restful api openapiThe primary objective of this project is to design and implement 40 API endpoints that power the Roam X mobile application. These endpoints will handle core functionalities such as user authentication, profile management, restaurant discovery, dinner club reservations, editorial list recommendations, and real-time user feedback. The goal is to ensure the backend provides secure, scalable, and efficient data flow between the mobile frontend and the database, enabling a seamless user experience. This experience is great for those looking to fine tune or develop their backend skills!
Key goals include:
- Establishing a consistent API architecture aligned with RESTful best practices (or GraphQL if required).
- Maintaining clear documentation and API testing coverage for developer usability.
- Creating APIs that are modular and reusable, allowing for future feature expansion without major refactoring.
By the end of this project, the following outcomes and deliverables are expected:
Fully Functional API Endpoints (40 total)
- Covering all defined use cases across authentication, user management, restaurant search, editorial lists, reviews, dinner club, payments, and analytics.
- Each endpoint tested and verified with Postman or similar API testing tools.
Database Integration
- APIs connected to the PostgreSQL RDS instance with secure queries.
- Proper indexing and schema design to support efficient retrieval.
Error Handling & Validation
- Standardized error responses and input validation implemented across endpoints.
- Logging and monitoring integrated for debugging and stability.
API Documentation
- Auto-generated and human-readable documentation (Swagger/OpenAPI).
- Endpoint descriptions including request/response examples and error codes.
Deployment-Ready Backend
- Endpoints deployed and accessible through API Gateway (
/recommendbase path + other namespaces). - CI/CD integration for smooth deployment and version control.
Optional:
Testing & Quality Assurance
- Unit and integration tests covering all major endpoints.
- Load testing to ensure APIs can handle projected user traffic.
Sharing knowledge in specific technical skills, techniques, methodologies required for the project.
Direct involvement in project tasks, offering guidance, and demonstrating techniques.
Providing access to necessary tools, software, and resources required for project completion.
Scheduled check-ins to discuss progress, address challenges, and provide feedback.
About the company
Headquartered in Toronto, Ontario, Roam X is a Canadian food discovery app that helps users find restaurants based on vibe, mood and occasion. Whether you’re planning a cozy date night, a solo lunch, or a night out with friends, Roam X curates dining experiences that match how you feel. We are proud to be a minority-led business, federally recognized in Canada as BIPOC-owned, and committed to inclusive hiring practices as an equal opportunity employer.
Basée à Toronto, en Ontario, Roam X est une application canadienne de découverte de restaurants qui aide les utilisateurs à trouver des établissements en fonction de l’ambiance, de l’humeur et de l’occasion. Que vous planifiiez un rendez-vous romantique, un déjeuner en solo ou une soirée entre amis, Roam X propose des expériences culinaires qui correspondent à ce que vous ressentez. Nous sommes fiers d’être une entreprise dirigée par des personnes issues de minorités, reconnue au niveau fédéral au Canada comme appartenant à un propriétaire BIPOC, et engagée envers des pratiques d’embauche inclusives en tant qu’employeur garantissant l’égalité des chances.
Main contact