You should never change the behavior of HTTP response codes in your API. Never change the behavior of HTTP response codes You could also have an automated test suite plugged into the CI/CD pipeline that checks for backward compatibility and alerts when there is a violation.
Ideally you should have a test suite for API testing that will fail and alert when there are issues with backward compatibility of the API. The tests should be written is such a way that they should fail if there are any backward compatibility problems. You should have tests written that will verify if the functionality is intact with a new release of the API. Now that we know what the problem is all about, how do we design our APIs the recommended way? How do we ensure that our RESTful API is backward compatible? This section lists some of the best practices that can be followed in this regard. public IActionResult GetOrders(int customerId, int orderId = 0) Īnd, that’s exactly how you can break the compatibility of your API! The section that follows discusses the best practices that can be adopted to make your API backward compatible.
#Greed corp backwards compatible code#
Assume that you have an API method named GetOrders as shown in the code snippet below. In other words, an API is backward compatible between releases if the clients should are able to work with a new version of the API seamlessly.
An API is backward compatible if a client (a program written to consume the API) that can work with one version of the API can work the same way with future versions of the API.
0 kommentar(er)
