[api] Configurar biblioteca de cobertura de testes

[alessandrofeitoza]

WHAT

Precisamos adicionar uma biblioteca para cobertura de testes que nos forneça informações a respeito de quantos % da aplicação estão testadas.

É provavel que o melhor caminho seja: https://github.com/sebastianbergmann/php-code-coverage

CHECKLIST

• Deixar disponivel um link para essa informação via web
• Adicionar a informação de cobertura no README do repositorio (exemplo abaixo)

Exemplo: https://github.com/corcel/corcel

[henriquelopeslima]

https://about.codecov.io

Para ter a informação de cobertura no README do repositório é necessário ter integrado a plataforma da codecov

Aqui está um exemplo com PHP

Measuring PHP code coverage with PHPUnit and Github Actions

Ponto importante, é grátis para projetos de código aberto.

Para entender melhor as métricas que serão utilizadas, basta seguir essa definição.