Download the PHP package engfabiodesalvi/busca-cep-php without Composer

On this page you can find all versions of the php package engfabiodesalvi/busca-cep-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of engfabiodesalvi/busca-cep-php

Informations about the package busca-cep-php

Busca CEP PHP

Uma biblioteca PHP moderna para consulta de CEP utilizando múltiplos provedores, implementando mecanismos de Retry, Failover, Circuit Breaker e Logging, com arquitetura baseada em boas práticas de desenvolvimento e componentes desacoplados.

A biblioteca centraliza consultas a diversos serviços de CEP em uma única API, permitindo que aplicações utilizem diferentes provedores de forma transparente e resiliente.

Principais características

Arquitetura

Instalação

Requisitos

Provedores suportados

Provider Suporte
AwesomeApi ✅
BrasilAPI ✅
CepAberto ✅
OpenCep ✅
ViaCep ✅

A arquitetura permite adicionar novos provedores facilmente sem modificar o restante da biblioteca.

Primeiro exemplo

Exemplo completo

Configuração

Alguns provedores necessitam de autenticação.

A biblioteca possui uma classe de configuração para armazenar parâmetros globais.

Exemplo:

Utilizando arquivo .env

Leitura da variável:

Dessa forma cada usuário utiliza seu próprio token sem alterar o código da biblioteca.

Retry

Caso um provedor apresente falha temporária, a biblioteca realiza novas tentativas automaticamente.

Failover

Se um provedor permanecer indisponível, a biblioteca tenta automaticamente o próximo provedor disponível.

Circuit Breaker

Providers que apresentam falhas consecutivas podem ser temporariamente ignorados, evitando chamadas repetidas para serviços indisponíveis.

Logging

A biblioteca suporta diferentes implementações de log.

Implementações disponíveis:

Exemplo:

Tratamento de exceções

A biblioteca possui exceções específicas para facilitar o tratamento de erros.

Exemplo:

Adicionando um novo Provider

Cada novo provedor deve implementar sua própria classe.

Também deverá possuir seu respectivo Normalizer.

Nenhuma modificação nas demais classes será necessária.

Estrutura dos testes

Os testes contemplam:

Qualidade de código

Ferramentas recomendadas:

Executar testes:

Executar análise estática:

Executar PHPCS:

Organização do projeto

Exemplos

A pasta examples/ contém exemplos completos de utilização da biblioteca.

Roadmap

Funcionalidades planejadas:

Contribuindo

Contribuições são bem-vindas.

  1. Faça um Fork.
  2. Crie uma branch.
  3. Implemente sua melhoria.
  4. Execute todos os testes.
  5. Envie um Pull Request.

Licença

Este projeto está licenciado sob a licença MIT.

Autor

Fabio Toledo Bonemer De Salvi

Engenheiro Eletricista, estudante de Análise e Desenvolvimento de Sistemas e desenvolvedor de software.

GitHub:

https://github.com/engfabiodesalvi

Agradecimentos

Agradecimentos à comunidade PHP e aos mantenedores dos serviços públicos de consulta de CEP utilizados por esta biblioteca.

All versions of busca-cep-php with dependencies

PHP Build Version
Package Version
Requires php Version >=8.3.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package engfabiodesalvi/busca-cep-php contains the following files

Loading the files please wait ...