{"id":47,"date":"2025-02-09T18:52:40","date_gmt":"2025-02-09T21:52:40","guid":{"rendered":"https:\/\/caminhodev.com.br\/?p=47"},"modified":"2025-02-09T20:33:50","modified_gmt":"2025-02-09T23:33:50","slug":"configurando-o-swagger-para-fastapi","status":"publish","type":"post","link":"https:\/\/caminhodev.com.br\/?p=47","title":{"rendered":"Como Configurar o Swagger no FastAPI 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 que permite documentar, testar e visualizar APIs REST de forma interativa. Ele facilita a explora\u00e7\u00e3o dos endpoints sem a necessidade de clientes HTTP externos, como Postman.<\/p>\n\n\n\n

No FastAPI<\/strong>, o Swagger j\u00e1 vem embutido por padr\u00e3o, permitindo gerar uma documenta\u00e7\u00e3o detalhada automaticamente sem precisar de bibliotecas externas.<\/p>\n\n\n\n

Passo 1: Instalando o FastAPI e o Uvicorn<\/strong><\/h2>\n\n\n\n

Para come\u00e7ar, instale o FastAPI<\/strong> e o servidor Uvicorn<\/strong> com o seguinte comando:<\/p>\n\n\n\n

<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
pip<\/span> <\/span>install<\/span> <\/span>fastapi<\/span> <\/span>uvicorn<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Passo 2: Criando um Projeto FastAPI<\/strong><\/h2>\n\n\n\n
Crie um arquivo chamado main.py<\/code> e adicione o seguinte c\u00f3digo:<\/p>\n\n\n\n
<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
from<\/span> <\/span>fastapi<\/span> <\/span>import<\/span> <\/span>FastAPI<\/span><\/span>\nfrom<\/span> <\/span>fastapi<\/span>.<\/span>openapi<\/span>.<\/span>utils<\/span> <\/span>import<\/span> <\/span>get_openapi<\/span><\/span>\n<\/span>\napp<\/span> = <\/span>FastAPI<\/span>()<\/span><\/span>\n<\/span>\n@<\/span>app<\/span>.<\/span>get<\/span>(<\/span>"<\/span>\/<\/span>"<\/span>)<\/span><\/span>\ndef<\/span> <\/span>root<\/span>():<\/span><\/span>\n    <\/span>return<\/span> <\/span>{<\/span>"<\/span>message<\/span>": "<\/span>Bem<\/span>-<\/span>vindo<\/span> <\/span>\u00e0<\/span> <\/span>API<\/span>"<\/span>}<\/span><\/span>\n<\/span>\n@<\/span>app<\/span>.<\/span>get<\/span>(<\/span>"<\/span>\/items\/{item_id}<\/span>"<\/span>)<\/span><\/span>\ndef<\/span> <\/span>read_item<\/span>(<\/span>item_id<\/span>: <\/span>int<\/span>,<\/span> <\/span>q<\/span>: <\/span>str<\/span> = <\/span>None<\/span>):<\/span><\/span>\n    <\/span>return<\/span> <\/span>{<\/span>"<\/span>item_id<\/span>": <\/span>item_id<\/span>,<\/span> "<\/span>q<\/span>": <\/span>q<\/span>}<\/span><\/span>\n<\/span>\n# <\/span>Customizando<\/span> <\/span>o<\/span> <\/span>OpenAPI<\/span> <\/span>para<\/span> <\/span>SEO<\/span><\/span>\n@<\/span>app<\/span>.<\/span>get<\/span>(<\/span>"<\/span>\/openapi.json<\/span>"<\/span>)<\/span><\/span>\ndef<\/span> <\/span>custom_openapi<\/span>():<\/span><\/span>\n    <\/span>return<\/span> <\/span>get_openapi<\/span>(<\/span><\/span>\n        <\/span>title<\/span>=<\/span>"<\/span>Minha API FastAPI<\/span>"<\/span>,<\/span><\/span>\n        <\/span>version<\/span>=<\/span>"<\/span>1.0.0<\/span>"<\/span>,<\/span><\/span>\n        <\/span>description<\/span>=<\/span>"<\/span>Documenta\u00e7\u00e3o da API com SEO<\/span>"<\/span>,<\/span><\/span>\n        <\/span>routes<\/span>=<\/span>app<\/span>.<\/span>routes<\/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
Agora, inicie o servidor executando:<\/p>\n\n\n\n
<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
uvicorn<\/span> main<\/span>:<\/span>app<\/span> <\/span>--<\/span>reload<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Ap\u00f3s iniciar, acesse os seguintes links para visualizar a documenta\u00e7\u00e3o:<\/p>\n\n\n\n