microsoft / api-guidelines

Microsoft REST API Guidelines
Other
22.67k stars 2.71k forks source link

Add Problem Details for HTTP APIs Error Reporting #189

Closed euclid47 closed 4 years ago

euclid47 commented 4 years ago

I would like to suggest adding Problem Details, RFC 7807, to the document.

garethj-msft commented 4 years ago

Hi eulid, If 7807 had been around when we were standardizing the way we did errors at MSFT, then I'd agree. At this time, the value of changing from our approach to 7807 or a compliant variant doesn't supersede the cost to customers of change and variance, so I'm going to reject this.

For those taking these guidelines and making their own, then I think it would be well worth a good, long look.