Skip to content

Samuel-Devx/ApiRestComConsultaDeCep

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

API REST com Consulta de CEP

Projeto de uma API REST que realiza consulta de endereços a partir de um CEP, integrando uma fonte externa de dados para retorno das informações de localização.


Sobre o Projeto

Esta API foi desenvolvida com foco em oferecer um serviço simples e útil de busca de endereço por CEP (Código de Endereçamento Postal). Ao receber um CEP válido, a API consulta uma fonte de dados externa (como um serviço de CEP público) e retorna os dados de endereço em formato JSON.

O projeto é ideal para ser utilizado em aplicações web ou mobile que precisem de uma funcionalidade de busca de CEP ou que dependam de dados de localização.


Tecnologias Utilizadas

  • Node.js
  • Express
  • Axios (ou biblioteca equivalente para requisições HTTP)
  • API de consulta de CEP (externa)

Funcionalidades

  • Endpoint API REST para consulta de endereço por CEP
  • Tratamento de erros e CEPs inválidos
  • Resposta em JSON com dados estruturados
  • Código organizado para fácil manutenção

Estrutura do Projeto

ApiRestComConsultaDeCep/
├── src/
│ ├── controllers/
│ ├── routes/
│ ├── services/
│ └── app.js
├── .env
├── package.json
└── README.md

Como Executar

  1. Clone o repositório:
git clone https://github.com/Samuel-Devx/ApiRestComConsultaDeCep.git

Acesse a pasta do projeto:

cd ApiRestComConsultaDeCep Instale as dependências:

npm install Configure as variáveis de ambiente:

Crie um arquivo .env com suas credenciais ou configurações necessárias para a API de consulta de CEP (se aplicável).

Inicie a aplicação:

npm start A API estará disponível em: http://localhost:3000

Exemplo de Requisição GET /cep/{cep}

GET http://localhost:3000/cep/01001000 ###Resposta:

{ "cep": "01001-000", "logradouro": "Praça da Sé", "bairro": "Sé", "localidade": "São Paulo", "uf": "SP" }

Autor

Projeto desenvolvido para estudo de APIs REST e integração com serviços externos.


About

Um projeto de ApiRest com um Crud Completo, que consome a api da ViaCep, para a consulta do Endereço

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages