https://github.com/heliofernandes404/spring-cloud-open-feign

API criada com o Spring Cloud OpenFeign é projetada para permitir a comunicação simplificada entre serviços, utilizando a anotação e configuração mínima para chamar outros serviços HTTP de maneira declarativa. Aqui está uma descrição detalhada dos componentes e funcionalidades da API.
https://github.com/heliofernandes404/spring-cloud-open-feign

Last synced: about 1 month ago
JSON representation

API criada com o Spring Cloud OpenFeign é projetada para permitir a comunicação simplificada entre serviços, utilizando a anotação e configuração mínima para chamar outros serviços HTTP de maneira declarativa. Aqui está uma descrição detalhada dos componentes e funcionalidades da API.

• Host: GitHub
• URL: https://github.com/heliofernandes404/spring-cloud-open-feign
• Owner: HelioFernandes404
• Created: 2024-05-21T18:00:30.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-05-21T18:05:24.000Z (8 months ago)
• Last Synced: 2024-05-21T19:33:53.534Z (8 months ago)
• Language: Java
• Homepage:
• Size: 69.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Descrição da API de Consulta de CEP

Visão Geral

Esta API foi desenvolvida utilizando Spring Boot e Spring Cloud OpenFeign para facilitar a consulta de Código de Endereçamento Postal (CEP) no Brasil. A API integra-se ao serviço ViaCEP para obter informações detalhadas sobre um CEP fornecido.

Funcionalidades

- Consulta de CEP: Permite consultar um CEP brasileiro e retornar informações detalhadas sobre o endereço associado, como logradouro, bairro, localidade, unidade federativa, entre outros.

- Validação de CEP: Verifica se o CEP fornecido está no formato correto (8 dígitos numéricos) antes de realizar a consulta na API do ViaCEP.

Endpoints

GET /clientviacep/cep/{cep}

Consulta informações sobre um endereço baseado no CEP fornecido.

- Parâmetros:

  - cep (path): O CEP a ser consultado. Deve conter 8 dígitos numéricos.

- Retorno:

  - 200 OK: Retorna os detalhes do endereço no formato JSON.

  - 400 Bad Request: Retorna um erro caso o CEP esteja em formato inválido.

  - 404 Not Found: Retorna um erro caso o CEP não seja encontrado na base de dados do ViaCEP.

```

- Exemplo de Chamada:

  GET /clientviacep/cep/01001000

```

```

- Exemplo de Resposta:

  {

    "cep": "01001-000",

    "logradouro": "Praça da Sé",

    "complemento": "lado ímpar",

    "bairro": "Sé",

    "localidade": "São Paulo",

    "uf": "SP",

    "ibge": "3550308",

    "gia": "1004",

    "ddd": "11",

    "siafi": "7107"

  }

```

Arquitetura

FeignClient

O cliente Feign é configurado para se comunicar com a API do ViaCEP, permitindo realizar consultas HTTP de forma simples e declarativa.