aspnet-api-versioning VS api-guidelines

- The DTOs on the server should generally not change without warning. A deprecation cycle should ideally be in place so consumers can keep up over time and front end development doesn't have to be lock-step with the services the consume. Ideally some period of time between service v1 being deprecated and service v2 being required to allow consumers to react ( in this case, you're the consumer, so be kind to yourself ). Deets: https://github.com/dotnet/aspnet-api-versioning

This API versioning can be parameterized with some options, including the default version or even how the versioning will be done, whether by URL, header or media type. For more details, you can access the official documentation.

A lista completa pode ser vista aqui: https://github.com/microsoft/aspnet-api-versioning/wiki/Version-Format

Check out the official API versioning Github repository to find out more information.

As a companion to this - Microsoft REST API Guidelines on GitHub.

This is a great, thorough and in-depth document from Microsoft: https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md

Thing is, I made some researches this morning, and I found nowhere a "data" wrapper, not in Microsoft API best practices [FR] (client is using Microsoft APIs), not in Microsoft API guidelines, not in OpenAPI offical specifications, nowhere in any blog I found this morning.

Microsoft REST API guidelines

I'm working on a web API where I'd like to follow the Microsoft API Guidelines. I thought this would be easy, because surely there would be plenty of libraries out there to support their guidelines, maybe Microsoft even has one out there (I thought). I haven't been able to find any.

Let's get started. As you might know, there are several ways to versioning API, by URL, HTTP header, etc. We are going to add API versioning by URL.