There is more of this guide.
Practice
12 questions- API designDesign the error responses for an API that accepts a complex JSON object. How do you tell the client what's wrong without leaking implementation?
- API designWhat's the right way to surface a partial-failure response — for example, a bulk operation where 9 of 10 items succeeded?
- API designTwo endpoints can return 'not found' for very different reasons. How do you make those distinguishable without leaking internals?
- API designWalk me through how you'd design retryable versus non-retryable error responses. What guidance do you give clients?
- API designValidation errors in an API often pile up. How do you return all of them in one response in a way clients can act on?
- API designA client sends a POST request with invalid JSON to your API. What HTTP status code should you return, and what information should be in the response body?