Criando sua primeira API com Django REST Framework

O Django REST Framework (DRF) é uma poderosa biblioteca para construir APIs em Django. Se você deseja criar sua primeira API, siga este guia passo a passo.

1. Criando um Projeto Django

Primeiro, instale o Django e o Django REST Framework:

pip install django djangorestframework

Crie um novo projeto Django:

django-admin startproject minha_api
cd minha_api

2. Criando um Aplicativo

Crie um novo aplicativo dentro do projeto:

python manage.py startapp api

Adicione rest_framework e api ao INSTALLED_APPS no settings.py:

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'rest_framework',
    'api',
]

3. Criando um Modelo e Serializador

Edite models.py do app api:

from django.db import models

class Cliente(models.Model):
    nome = models.CharField(max_length=100)
    email = models.EmailField(unique=True)
    telefone = models.CharField(max_length=15)

Crie um serializador em serializers.py:

from rest_framework import serializers
from .models import Cliente

class ClienteSerializer(serializers.ModelSerializer):
    class Meta:
        model = Cliente
        fields = '__all__'

4. Criando uma View e URL

Edite views.py:

from rest_framework import viewsets
from .models import Cliente
from .serializers import ClienteSerializer

class ClienteViewSet(viewsets.ModelViewSet):
    queryset = Cliente.objects.all()
    serializer_class = ClienteSerializer

Adicione as rotas em urls.py:

from django.urls import path, include
from rest_framework.routers import DefaultRouter
from .views import ClienteViewSet

router = DefaultRouter()
router.register(r'clientes', ClienteViewSet)

urlpatterns = [
    path('api/', include(router.urls)),
]

5. Aplicando Migrações e Testando

Execute as migrações:

python manage.py makemigrations api
python manage.py migrate

Crie um superusuário para acessar o Django Admin:

python manage.py createsuperuser

Execute o servidor:

python manage.py runserver

Agora, você pode acessar http://127.0.0.1:8000/api/clientes/ e testar sua API!

Conclusão

Com apenas alguns passos, você criou sua primeira API RESTful usando Django REST Framework. Agora, você pode expandi-la conforme necessário para atender às suas necessidades.

Avatar photo

O CaminhoDev é mais do que um blog, é um guia para quem deseja evoluir na programação e construir uma carreira sólida no mundo da tecnologia. Aqui, compartilhamos conteúdos de alta qualidade desenvolvimento web, automação e boas práticas de código.

Publicar comentário