{"id":39,"date":"2025-02-09T18:40:51","date_gmt":"2025-02-09T21:40:51","guid":{"rendered":"https:\/\/caminhodev.com.br\/?p=39"},"modified":"2025-02-09T20:33:32","modified_gmt":"2025-02-09T23:33:32","slug":"criando-sua-primeira-api-com-django-rest-framework","status":"publish","type":"post","link":"https:\/\/caminhodev.com.br\/?p=39","title":{"rendered":"Criando sua primeira API com Django REST Framework"},"content":{"rendered":"\n

O Django REST Framework (DRF) \u00e9 uma poderosa biblioteca para construir APIs em Django. Se voc\u00ea deseja criar sua primeira API, siga este guia passo a passo.<\/p>\n\n\n\n

1. Criando um Projeto Django<\/h3>\n\n\n\n

Primeiro, instale o Django e o Django REST Framework:<\/p>\n\n\n\n

<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
pip<\/span> <\/span>install<\/span> <\/span>django<\/span> <\/span>djangorestframework<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Crie um novo projeto Django:<\/p>\n\n\n\n
<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
django<\/span>-<\/span>admin<\/span> <\/span>startproject<\/span> <\/span>minha_api<\/span><\/span>\ncd<\/span> <\/span>minha_api<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
2. Criando um Aplicativo<\/h3>\n\n\n\n
Crie um novo aplicativo dentro do projeto:<\/p>\n\n\n\n
<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
python<\/span> <\/span>manage<\/span>.<\/span>py<\/span> <\/span>startapp<\/span> <\/span>api<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Adicione rest_framework<\/code> e api<\/code> ao INSTALLED_APPS<\/code> no settings.py<\/code>:<\/p>\n\n\n\n
<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
INSTALLED_APPS<\/span> <\/span>=<\/span> [<\/span><\/span>\n    <\/span>'<\/span>django.contrib.admin<\/span>'<\/span>,<\/span><\/span>\n    <\/span>'<\/span>django.contrib.auth<\/span>'<\/span>,<\/span><\/span>\n    <\/span>'<\/span>rest_framework<\/span>'<\/span>,<\/span><\/span>\n    <\/span>'<\/span>api<\/span>'<\/span>,<\/span><\/span>\n]<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
3. Criando um Modelo e Serializador<\/h3>\n\n\n\n
Edite models.py<\/code> do app api<\/code>:<\/p>\n\n\n\n
<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
from<\/span> <\/span>django<\/span>.<\/span>db<\/span> <\/span>import<\/span> <\/span>models<\/span><\/span>\n<\/span>\nclass<\/span> <\/span>Cliente<\/span>(<\/span>models<\/span>.<\/span>Model<\/span>):<\/span><\/span>\n    <\/span>nome<\/span> = <\/span>models<\/span>.<\/span>CharField<\/span>(<\/span>max_length<\/span>=100)<\/span><\/span>\n    <\/span>email<\/span> = <\/span>models<\/span>.<\/span>EmailField<\/span>(<\/span>unique<\/span>=<\/span>True<\/span>)<\/span><\/span>\n    <\/span>telefone<\/span> = <\/span>models<\/span>.<\/span>CharField<\/span>(<\/span>max_length<\/span>=15)<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Crie um serializador em serializers.py<\/code>:<\/p>\n\n\n\n
<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
from<\/span> <\/span>rest_framework<\/span> <\/span>import<\/span> <\/span>serializers<\/span><\/span>\nfrom<\/span> .<\/span>models<\/span> <\/span>import<\/span> <\/span>Cliente<\/span><\/span>\n<\/span>\nclass<\/span> <\/span>ClienteSerializer<\/span>(<\/span>serializers<\/span>.<\/span>ModelSerializer<\/span>):<\/span><\/span>\n    <\/span>class<\/span> <\/span>Meta<\/span>:<\/span><\/span>\n        <\/span>model<\/span> = <\/span>Cliente<\/span><\/span>\n        <\/span>fields<\/span> = <\/span>'<\/span>__all__<\/span>'<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
4. Criando uma View e URL<\/h3>\n\n\n\n
Edite views.py<\/code>:<\/p>\n\n\n\n
<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
from<\/span> <\/span>rest_framework<\/span> <\/span>import<\/span> <\/span>viewsets<\/span><\/span>\nfrom<\/span> .<\/span>models<\/span> <\/span>import<\/span> <\/span>Cliente<\/span><\/span>\nfrom<\/span> .<\/span>serializers<\/span> <\/span>import<\/span> <\/span>ClienteSerializer<\/span><\/span>\n<\/span>\nclass<\/span> <\/span>ClienteViewSet<\/span>(<\/span>viewsets<\/span>.<\/span>ModelViewSet<\/span>):<\/span><\/span>\n    <\/span>queryset<\/span> = <\/span>Cliente<\/span>.<\/span>objects<\/span>.<\/span>all<\/span>()<\/span><\/span>\n    <\/span>serializer_class<\/span> = <\/span>ClienteSerializer<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Adicione as rotas em urls.py<\/code>:<\/p>\n\n\n\n
<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
from<\/span> <\/span>django<\/span>.<\/span>urls<\/span> <\/span>import<\/span> <\/span>path<\/span>,<\/span> <\/span>include<\/span><\/span>\nfrom<\/span> <\/span>rest_framework<\/span>.<\/span>routers<\/span> <\/span>import<\/span> <\/span>DefaultRouter<\/span><\/span>\nfrom<\/span> .<\/span>views<\/span> <\/span>import<\/span> <\/span>ClienteViewSet<\/span><\/span>\n<\/span>\nrouter<\/span> = <\/span>DefaultRouter<\/span>()<\/span><\/span>\nrouter<\/span>.<\/span>register<\/span>(<\/span>r<\/span>'<\/span>clientes<\/span>'<\/span>,<\/span> <\/span>ClienteViewSet<\/span>)<\/span><\/span>\n<\/span>\nurlpatterns<\/span> = [<\/span><\/span>\n    <\/span>path<\/span>(<\/span>'<\/span>api\/<\/span>'<\/span>,<\/span> <\/span>include<\/span>(<\/span>router<\/span>.<\/span>urls<\/span>))<\/span>,<\/span><\/span>\n]<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
5. Aplicando Migra\u00e7\u00f5es e Testando<\/h3>\n\n\n\n
Execute as migra\u00e7\u00f5es:<\/p>\n\n\n\n
<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
python<\/span> <\/span>manage<\/span>.<\/span>py<\/span> <\/span>makemigrations<\/span> <\/span>api<\/span><\/span>\npython<\/span> <\/span>manage<\/span>.<\/span>py<\/span> <\/span>migrate<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Crie um superusu\u00e1rio para acessar o Django Admin:<\/p>\n\n\n\n
<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
python<\/span> <\/span>manage<\/span>.<\/span>py<\/span> <\/span>createsuperuser<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Execute o servidor:<\/p>\n\n\n\n
<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
python<\/span> <\/span>manage<\/span>.<\/span>py<\/span> <\/span>runserver<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Agora, voc\u00ea pode acessar http:\/\/127.0.0.1:8000\/api\/clientes\/<\/a><\/code> e testar sua API!<\/p>\n\n\n\n
Conclus\u00e3o<\/h3>\n\n\n\n
Com apenas alguns passos, voc\u00ea criou sua primeira API RESTful usando Django REST Framework. Agora, voc\u00ea pode expandi-la conforme necess\u00e1rio para atender \u00e0s suas necessidades.<\/p>\n","protected":false},"excerpt":{"rendered":"
O Django REST Framework (DRF) \u00e9 uma poderosa biblioteca para construir APIs em Django. Se voc\u00ea 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: Crie um novo projeto Django: 2. Criando um Aplicativo Crie um novo aplicativo dentro […]<\/p>\n","protected":false},"author":1,"featured_media":43,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"om_disable_all_campaigns":false,"_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"footnotes":""},"categories":[4,2],"tags":[8,10,6,9,12,15,11,14,7,13],"class_list":["post-39","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-django","category-python","tag-apis","tag-backend","tag-desenvolvimentoweb","tag-django","tag-djangoframework","tag-djangopython","tag-frameworkweb","tag-programacao","tag-python","tag-webdevelopment"],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/caminhodev.com.br\/index.php?rest_route=\/wp\/v2\/posts\/39","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/caminhodev.com.br\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/caminhodev.com.br\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/caminhodev.com.br\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/caminhodev.com.br\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=39"}],"version-history":[{"count":1,"href":"https:\/\/caminhodev.com.br\/index.php?rest_route=\/wp\/v2\/posts\/39\/revisions"}],"predecessor-version":[{"id":40,"href":"https:\/\/caminhodev.com.br\/index.php?rest_route=\/wp\/v2\/posts\/39\/revisions\/40"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/caminhodev.com.br\/index.php?rest_route=\/wp\/v2\/media\/43"}],"wp:attachment":[{"href":"https:\/\/caminhodev.com.br\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=39"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/caminhodev.com.br\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=39"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/caminhodev.com.br\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=39"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}