Skip to content

cardtunic/cep-api

Repository files navigation

CEP API

Repositório contendo API para consulta de CEPs. Os dados são importados do dataset https://www.cepaberto.com para um banco de dados PostgreSQL bem simples, composto de apenas 3 tabelas (ceps, states e cities).

O deploy da API é feito para um Cloudflare Worker, que se conecta com o banco de dados externo por meio do Hyperdrive.

Deploy to Cloudflare

🔍️ Utilização

curl http://localhost:8787/api/v1/ceps/:cep

💻️ Rodando localmente

pnpm i
pnpm dev

🚀 Deploy

pnpm run deploy

🌱 Seed do banco de dados

pnpm db:seed --input /dir --db "postgresql://postgres:root@localhost:5432"
  • --input: caminho para diretório com arquivos .zip baixados do cepaberto. Não devem ser renomeados.

  • --db: URL de conexão com banco de dados

Esse comando executa o arquvio seed.ts, que passa por cada arquivo .zip, extrai e envia o conteúdo dos CSV diretamente para as tabelas do banco de dados por meio do comando COPY, para uma inserção performática.

About

Repositório contendo API para consulta de CEPs. Os dados são importados do dataset https://www.cepaberto.com.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors