{"id":44,"date":"2025-02-09T18:50:32","date_gmt":"2025-02-09T21:50:32","guid":{"rendered":"https:\/\/caminhodev.com.br\/?p=44"},"modified":"2025-02-09T20:33:39","modified_gmt":"2025-02-09T23:33:39","slug":"configurando-o-swagger-para-django-rest-framework-com-foco-em-seo","status":"publish","type":"post","link":"https:\/\/caminhodev.com.br\/?p=44","title":{"rendered":"Como Configurar o Swagger no Django REST Framework para Documenta\u00e7\u00e3o de APIs"},"content":{"rendered":"\n

O que \u00e9 Swagger e por que us\u00e1-lo?<\/strong><\/h3>\n\n\n\n

Swagger \u00e9 um conjunto de ferramentas para documentar, visualizar e testar APIs de forma interativa. Ele gera automaticamente uma interface gr\u00e1fica onde desenvolvedores e consumidores da API podem explorar os endpoints e testar requisi\u00e7\u00f5es sem a necessidade de ferramentas externas, como Postman.<\/p>\n\n\n\n

No Django REST Framework, a biblioteca drf-yasg<\/strong> permite adicionar suporte ao Swagger de maneira simples e eficiente. Isso facilita a manuten\u00e7\u00e3o da API e melhora a comunica\u00e7\u00e3o entre equipes de desenvolvimento.<\/p>\n\n\n\n

Passo 1: Instalando o Swagger no Django REST Framework<\/strong><\/h2>\n\n\n\n

Para come\u00e7ar, instale o pacote necess\u00e1rio executando o seguinte comando no terminal:<\/p>\n\n\n\n

<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
pip<\/span> <\/span>install<\/span> <\/span>drf<\/span>-<\/span>yasg<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Ap\u00f3s a instala\u00e7\u00e3o, adicione a biblioteca drf_yasg<\/code> ao seu arquivo settings.py<\/code> dentro de INSTALLED_APPS<\/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>rest_framework<\/span>'<\/span>,<\/span><\/span>\n    <\/span>'<\/span>drf_yasg<\/span>'<\/span>,<\/span><\/span>\n]<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Passo 2: Configurando o Swagger no Django<\/strong><\/h2>\n\n\n\n
Agora, edite o arquivo urls.py<\/code> e adicione a configura\u00e7\u00e3o do Swagger:<\/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>re_path<\/span><\/span>\nfrom<\/span> <\/span>rest_framework<\/span> <\/span>import<\/span> <\/span>permissions<\/span><\/span>\nfrom<\/span> <\/span>drf_yasg<\/span>.<\/span>views<\/span> <\/span>import<\/span> <\/span>get_schema_view<\/span><\/span>\nfrom<\/span> <\/span>drf_yasg<\/span> <\/span>import<\/span> <\/span>openapi<\/span><\/span>\n<\/span>\nschema_view<\/span> = <\/span>get_schema_view<\/span>(<\/span><\/span>\n    <\/span>openapi<\/span>.<\/span>Info<\/span>(<\/span><\/span>\n        <\/span>title<\/span>=<\/span>"<\/span>Minha API<\/span>"<\/span>,<\/span><\/span>\n        <\/span>default_version<\/span>=<\/span>'<\/span>v1<\/span>'<\/span>,<\/span><\/span>\n        <\/span>description<\/span>=<\/span>"<\/span>Documenta\u00e7\u00e3o da API usando Swagger<\/span>"<\/span>,<\/span><\/span>\n    )<\/span>,<\/span><\/span>\n    <\/span>public<\/span>=<\/span>True<\/span>,<\/span><\/span>\n    <\/span>permission_classes<\/span>=(<\/span>permissions<\/span>.<\/span>AllowAny<\/span>,<\/span>)<\/span>,<\/span><\/span>\n)<\/span><\/span>\n<\/span>\nurlpatterns<\/span> = [<\/span><\/span>\n    <\/span>re_path<\/span>(<\/span>r<\/span>'<\/span>^swagger\/$<\/span>'<\/span>,<\/span> <\/span>schema_view<\/span>.<\/span>with_ui<\/span>(<\/span>'<\/span>swagger<\/span>'<\/span>,<\/span> <\/span>cache_timeout<\/span>=0)<\/span>,<\/span> <\/span>name<\/span>=<\/span>'<\/span>schema-swagger-ui<\/span>'<\/span>)<\/span>,<\/span><\/span>\n    <\/span>re_path<\/span>(<\/span>r<\/span>'<\/span>^redoc\/$<\/span>'<\/span>,<\/span> <\/span>schema_view<\/span>.<\/span>with_ui<\/span>(<\/span>'<\/span>redoc<\/span>'<\/span>,<\/span> <\/span>cache_timeout<\/span>=0)<\/span>,<\/span> <\/span>name<\/span>=<\/span>'<\/span>schema-redoc<\/span>'<\/span>)<\/span>,<\/span><\/span>\n]<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Passo 3: Acessando a documenta\u00e7\u00e3o da API<\/strong><\/h2>\n\n\n\n
Ap\u00f3s configurar as rotas, inicie o servidor Django com:<\/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, acesse os seguintes URLs no navegador para visualizar a documenta\u00e7\u00e3o:<\/p>\n\n\n\n