Error Messages for HTTP APIs: Standards, Patterns, and Practices

Reporting errors is a fundamental aspect of API design. The way it’s done can differ between APIs, API technologies, and API styles, but since it is a very common pattern it makes sense to not reinvent the wheel for every single API. We look at how to report errors in HTTP APIs, but the lessons learned in this session can be applied to other technologies and styles as well. Beyond the format, there also is the question which patterns to apply so that API designers get as much support as possible from their platform when it comes to managing the error messages of their APIs. The format that we discuss is a successor of the popular RFC 7807 error format. We’ll discuss why there is a new version, what the changes are, and how to best use it in your APIs and your API landscape.

Date: 2024-05-14
Time: 14:30 - 15:15
Online Event: betterCode() API

Speaker

Erik Wilde Principal Consultant

With over 10 years of experience in the API field, Erik is passionate about helping organizations on their digital transformation journeys, making sure that vision, strategy, and technology are aligned, and that they are driven by well-aligned business and organizational initiatives. As an OAI Ambassador at the OpenAPI Initiative, he promotes the adoption and use of open standards and best practices for API design and management, and with Getting APIs to Work, I provide consulting and training services for API programs.

Error Messages for HTTP APIs: Standards, Patterns, and Practices

TAGS