Configurando um projeto Django Rest Framework (DRF)

✅ Atualizado para DRF 3.15 (Setembro 2024)
Django 5.1, Django REST Framework 3.15, configuração moderna de APIs.

Salve salve Pythonista!

Neste artigo, abordaremos a configuração de um projeto Django Rest Framework (DRF), incluindo a configuração do arquivo requirements.txt e do próprio Django Rest Framework.

Entender como configurar um projeto com DRF é essencial para quem deseja construir APIs robustas e escaláveis utilizando o Django, que é um dos frameworks mais populares para desenvolvimento web em Python.

Configurando o Django Rest Framework corretamente garantirá que seu projeto esteja pronto para adicionar, gerenciar e expor dados por meio de APIs RESTful.

Vá Direto ao Assunto…

• Passo 1: Criando e configurando um novo projeto Django
• Passo 2: Instalar o Django Rest Framework
• Passo 3: Configurando o Django Rest Framework
• Configurações Essenciais do DRF

Passo 1: Criando e configurando um novo projeto Django

Primeiro, precisamos instalar o Django e criar um novo projeto.

Certifique-se de ter o Python e o pip instalados em seu sistema.

Crie um novo ambiente virtual e instale as dependências.

Se ainda não sabe como criar ambientes virtuais para seus projetos Python, PRECISA ler esse artigo agora: Python e Virtualenv: como programar em Ambientes Virtuais

Com um ambiente virtual criado e ativado:

1
2
3
4

pip install django
django-admin startproject meu_projeto
cd meu_projeto
python manage.py startapp minha_app

Isso irá instalar o Django, iniciar um novo projeto com startproject e criar um novo App Django chamado minha_app.

Passo 2: Instalar o Django Rest Framework

Em seu recente criado ambiente virtual, instale o Django Rest Framework utilizando pip.

Adicione-o ao seu projeto Django configurando seu arquivo requirements.txt.

1

pip install djangorestframework

Crie um arquivo requirements.txt na raiz do seu projeto e adicione as dependências necessárias.

1
2

django
djangorestframework

Você pode instalar todas as dependências do requirements.txt com o comando:

1

pip install -r requirements.txt

Projeto Django na prática: O DevBook é um projeto real construído com Django. Uma plataforma que gera ebooks técnicos com IA, processamento assíncrono e exportação em PDF. Quer ver como ficou? Dá uma olhada!

Passo 3: Configurando o Django Rest Framework

Abra o arquivo settings.py do seu projeto Django e adicione 'rest_framework' à lista de aplicativos instalados:

1
2
3
4
5

INSTALLED_APPS = [
    ...
    'rest_framework',
    'minha_app',
]

Pronto, com isso você estará pronto para iniciar o desenvolvimento de APIs REST com Django REST Framework!

Configurações Essenciais do DRF

Permissões e Autenticação

1
2
3
4
5
6
7
8
9
10
11

REST_FRAMEWORK = {
    'DEFAULT_PERMISSION_CLASSES': [
        'rest_framework.permissions.IsAuthenticatedOrReadOnly',
    ],
    'DEFAULT_AUTHENTICATION_CLASSES': [
        'rest_framework.authentication.SessionAuthentication',
        'rest_framework.authentication.TokenAuthentication',
    ],
    'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',
    'PAGE_SIZE': 10
}

CORS (Cross-Origin Resource Sharing)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

# requirements.txt
django-cors-headers

# settings.py
INSTALLED_APPS = [
    ...,
    'corsheaders',
    'rest_framework',
]

MIDDLEWARE = [
    'corsheaders.middleware.CorsMiddleware',
    ...
]

CORS_ALLOWED_ORIGINS = [
    "http://localhost:3000",
    "http://127.0.0.1:3000",
]

Fique ligado pois nos próximos artigos vamos falar sobre a configuração de rotas da sua API, como criar Viewsets para expôr dados, como criar Serializers para converter seus dados de objetos Python para representação JSON e vice-versa e muito mais!

Conclusão

Neste artigo, vimos como configurar um projeto Django Rest Framework.

Configuramos o arquivo requirements.txt, instalamos e configuramos o Django Rest Framework para criarmos APIs REST.

Com essas configurações, você está preparado para desenvolver APIs RESTful robustas utilizando Django e DRF!

Fique ligado nos próximos artigos!

Até lá

Por Vinícius Ramos em 07/09/2024

Engenheiro de Computação pela UnB com especialização em Inteligência Artificial. Sr. Software Engineer com 10+ anos de experiência desenvolvendo sistemas críticos em Python e Django. Atuei no Banco do Brasil liderando equipes para monitoramento de mainframe, trabalhei como desenvolvedor sênior em projetos forenses para a Polícia Federal, e atualmente sou engenheiro de software na Labcorp (Estados Unidos), desenvolvendo soluções escaláveis para testes genéticos. Fundador da Python Academy, compartilhando conhecimento técnico com a comunidade brasileira desde 2018.

Minhas redes: