diff --git a/README.md b/README.md index 7062b43..fe49df2 100644 --- a/README.md +++ b/README.md @@ -42,4 +42,4 @@ There are two comon approaches to doing this : 1. By prefixing all URLs with your API version, like **/v1/healthcheck** or **/v2/healthcheck** 2. By using custom **Accept** and **Content-Type** headers on requests and responses to convey the API version, like **Accept: application/vnd.greenlight-v1** -From a HTTP semantics point of view, using headers to convey the API version is the 'purer' approach. But from a user-experience point of view, using a URL prefix is arguably better. It makes it possible for developers to see which version of the API is being used at a glance, and it also means that the API can still be explored using a regular web browser (which is hearder if custom headers are required). \ No newline at end of file +From an HTTP semantics point of view, using headers to convey the API version is the 'purer' approach. But from a user-experience point of view, using a URL prefix is arguably better. It makes it possible for developers to see which version of the API is being used at a glance, and it also means that the API can still be explored using a regular web browser (which is harder if custom headers are required). \ No newline at end of file