Template
91 lines
3.4 KiB
Markdown
91 lines
3.4 KiB
Markdown
# Encurtador de links em FastAPI
|
|
|
|
Um encurtador de links pronto para publicar na [Dado](https://dado.cloud): cole um link
|
|
comprido, receba um endereço curto e acompanhe quantas vezes ele foi aberto.
|
|
|
|
Este repositório nasceu de um modelo da Dado. Cada `git push` na branch `main` publica
|
|
uma versão nova do seu app, sozinho.
|
|
|
|
## O que tem aqui
|
|
|
|
- `main.py`: o app FastAPI — página, API (`POST/GET /api/links`), o aviso `GET /<código>` e o redirecionamento `GET /<código>/ir` (302).
|
|
- `links.py`: onde os links ficam guardados (na memória) e a validação dos endereços.
|
|
- `paginas/index.html`: a página (HTML, CSS e o JavaScript do formulário). Mude à vontade.
|
|
- `paginas/aviso.html`: a página de aviso que mostra para onde o link leva, antes de sair.
|
|
- `paginas/nao-encontrado.html`: a página de link que não existe.
|
|
- `requirements.txt`: as dependências, com versão fixa.
|
|
|
|
Não tem banco de dados: os links ficam na memória do app e **somem quando ele é publicado
|
|
de novo**. Veja no fim como guardar de vez.
|
|
|
|
## Rodar no seu computador
|
|
|
|
Precisa de Python 3.11 ou mais novo.
|
|
|
|
```bash
|
|
git clone https://git.dado.cloud/<sua-conta>/encurtador-fastapi.git
|
|
cd encurtador-fastapi
|
|
python3 -m venv .venv
|
|
source .venv/bin/activate # no Windows: .venv\Scripts\activate
|
|
pip install -r requirements.txt
|
|
uvicorn main:app --reload
|
|
```
|
|
|
|
Abra http://localhost:8000.
|
|
|
|
Quando o `git clone` pedir usuário e senha, use o usuário da sua conta de Repositórios e,
|
|
como senha, o **token de Repositórios** (no painel da Dado, em Repositórios). O comando
|
|
certinho do seu app aparece no painel, em Deploys, na visão geral do app.
|
|
|
|
## Mudar e publicar
|
|
|
|
Edite o que quiser e mande para a Dado:
|
|
|
|
```bash
|
|
git add .
|
|
git commit -m "Minha primeira mudança"
|
|
git push
|
|
```
|
|
|
|
O push na branch `main` publica uma versão nova. Dá para acompanhar o andamento em
|
|
Deploys, no painel.
|
|
|
|
## Variável de ambiente de exemplo
|
|
|
|
A mensagem em "Sobre este deploy" vem da variável `MENSAGEM_BOAS_VINDAS`. Para trocar,
|
|
abra Deploys no painel, clique em "Variáveis de ambiente" no seu app, salve e publique de
|
|
novo. No seu computador:
|
|
|
|
```bash
|
|
MENSAGEM_BOAS_VINDAS="Oi, mundo" uvicorn main:app --reload
|
|
```
|
|
|
|
## API
|
|
|
|
```bash
|
|
# Encurtar
|
|
curl -X POST https://<endereço-do-seu-app>/api/links \
|
|
-H 'Content-Type: application/json' \
|
|
-d '{"url": "https://exemplo.com.br/uma-pagina"}'
|
|
# 201 {"codigo":"a1b2c3","url":"https://exemplo.com.br/uma-pagina","curto":"https://<endereço-do-seu-app>/a1b2c3","cliques":0,"criadoEm":"..."}
|
|
|
|
# Últimos 20 links
|
|
curl https://<endereço-do-seu-app>/api/links
|
|
# 200 {"links":[...]}
|
|
```
|
|
|
|
`GET /<código>` abre uma página de aviso com o endereço de destino e o botão "Continuar",
|
|
que leva a `GET /<código>/ir`: ali o app soma um clique e redireciona (302) para o link
|
|
original. O aviso existe porque o encurtador é público — sem ele, qualquer pessoa poderia
|
|
usar o endereço do seu app para disfarçar um link de golpe. A API aceita
|
|
chamadas de qualquer site (CORS aberto só em `/api/*`), então outro app seu pode usá-la.
|
|
Para evitar abuso, cada IP cria no máximo 30 links a cada 10 minutos.
|
|
|
|
A documentação interativa da API (do próprio FastAPI) fica em `/docs`.
|
|
|
|
## Guardar os links de vez
|
|
|
|
Para os links sobreviverem a uma nova publicação, ligue um Postgres no app (painel, em
|
|
Deploys, aba "Banco de dados" do app). A conexão chega ao app na variável `DATABASE_URL`;
|
|
aí é trocar o que está em `links.py` por consultas ao banco.
|