2 Endpoint Challenge

In today’s world of complex microservices architectures and sprawling APIs, there’s beauty in simplicity. The “2 Endpoint Challenge” pushes developers to create meaningful functionality with minimal complexity - just two API endpoints.

The Challenge

Create a functional product or service using exactly two API endpoints. This challenge encourages creative problem-solving and efficient API design by imposing strict limitations on the number of available endpoints.

Requirements

• Your API must have exactly 2 endpoints
• Both endpoints must serve a clear purpose in your product
• The endpoints can use any HTTP method (GET, POST, PUT, DELETE, etc.)
• You must include proper error handling and validation
• Your API must solve a real problem or provide genuine utility

Scoring Criteria

Submissions will be evaluated based on:

1. Utility: How useful and practical is the product built with just two endpoints?
2. Design: How well-designed are the endpoints in terms of REST principles and API design best practices?
3. Implementation: How robust is the error handling, validation, and overall code quality?
4. Creativity: How innovative is your solution given the constraints?
5. Documentation: How clear and comprehensive is your API documentation?

Tips and Suggestions

• Consider combining related operations into a single endpoint using different HTTP methods
• Use query parameters and request bodies effectively to maximize endpoint flexibility
• Think about stateless designs that can accomplish more with less
• Focus on solving one specific problem really well
• Consider using path parameters to handle multiple resources through a single endpoint
• Remember that complex business logic can still exist behind simple endpoints

Resources

• REST API Best Practices
• API Design Guidelines
• HTTP Status Codes
• OpenAPI Specification
• JSON Schema

Remember, the goal is to demonstrate that powerful and useful applications can be built with minimal API surface area. Focus on making your two endpoints as robust and valuable as possible. Good luck!