Django Rest Framework: Versionamento

Outras aplicações e sistemas que consomem a API, não precisam de tal alteração ou nova funcionalidade. Sabendo disso, o que fazer?

A resposta é Versionar a API.

Os clientes existentes podem usar a versão antiga da API sem alteração ou novas funcionalidades, e outros clientes, podem usar a nova versão da API com as novas atualizações.

Versionamento no Django Rest Framework

No Django Rest, existem algumas formas de versionar uma API. Vejamos a seguir alguns exemplos:

QueryParameterVersioning

Transfere a versão através do parâmetro version

Exemplo:

HostNameVersioning

A versão é definida pelo nome de domínio

Exemplo:

NamespaceVersioning

A versão é fornecida através do namespace da url

Exemplo:

URLPathVersioning

Adiciona a versão no endereço do recurso de uma variável (o caminho é verificado através do parâmetro VERSION_PARAM)

Exemplo:

AcceptHeaderVersioning

Transferência do número da versão através do cabeçalho da requisição

Exemplo:

Não podemos esquecer de incluir o tipo de versionamento na variável de ambiente do REST_FRAMEWORK no arquivo settings.py. Por exemplo:

Conclusão

Versionar uma API garante que ela seja atualizada com novas funcionalidades ou alterações para alguns clientes, sem comprometer aqueles que já a utilizam.

Quer aprender mais sobre Python, Veja:

• Python do zero - Formação na linguagem mais querida do momento
• Python para Web - Formação Django
• API com Python - Curso Django Rest Framework