API REST com FastAPI e PostgreSQL
Bem-vindo à documentação da API REST construída com FastAPI e PostgreSQL. Esta documentação fornece informações sobre como usar a API e seus endpoints.
Visão Geral
Esta API permite que os usuários registrem-se, façam login e consultem dados meteorológicos. A API é construída usando FastAPI e PostgreSQL, e é executada em contêineres Docker.
API Aberta
A api está disponível em:
Nela, você pode:
-
Registrar um novo usuário:
-
Fazer login:
-
Consultar dados meteorológicos:
onaws.com
Endpoints
Configuração e Execução
Pré-requisitos
- Docker
- Docker Compose
Passos para executar o projeto
-
Baixe o docker compose aqui:
-
Rode o comando
docker-compose up -d -
Accesse a documentação da API em:
http://localhost:8000/docs
Como Usar a API
Pelo terminal
Para acessar a API pelo terminal, você pode usar o comando curl. Aqui estão alguns exemplos de como usar a API:
-
Registrar um novo usuário:
-
Fazer login:
-
Consultar dados meteorológicos:
Pela documentação
A aplicação possui uma documentação interativa que pode ser acessada em http://localhost:8000/docs. A documentação permite que você teste os endpoints da API e veja exemplos de requisições e respostas.
