Anunciando o SDK do .NET versão 5.0.0

Tenho o prazer de anunciar o lançamento do nosso novo SDK do .NET 5.0.0. Este é meu primeiro grande lançamento desde que entrei para a equipe de Plataforma e Experiência do Desenvolvedor da Vonage no ano passado, e estou animado para compartilhar as novidades.

Novos recursos

Adicionamos alguns novos recursos ao SDK do .NET; segue uma lista deles.

SDK reformulado de acordo com as convenções do .NET

As versões anteriores do SDK não pareciam muito “.NET”; esta versão corrige isso.

• Abstraímos todas as chamadas de API por meio de interfaces, permitindo uma fácil substituição por meio da injeção de dependências para seus testes. Por exemplo, a classe SMS dos SDKs legados é substituída pela ISmsClient interface, que você pode utilizar diretamente ou substituir por conta própria.

• Todas as novas estruturas e APIs agora estão em conformidade com as convenções de nomenclatura do .NET. Além disso, introduzimos várias novas enums para eliminar alguns campos de string abertos. Preservamos as estruturas legadas, mas as marcamos como obsoletas como um lembrete para que os usuários atualizem para a versão mais recente, já que isso facilitará a atualização.

Nova metodologia de registro

Foi adicionado um novo recurso de registro de logs ao SDK desenvolvido com base em Microsoft.Extensions.Logging. Assim, você pode configurar o registro de logs do SDK para usar qualquer formato de log que desejar; pode adaptá-lo aos seus próprios logs da maneira que quiser, e não há necessidade de registrar as saídas dos nossos SDKs em seus arquivos de log.

Veja meu guia explicativo sobre como isso está estruturado e como você pode começar a registrar seus próprios logs!

Arquivo de documentação resumida adicionado

O SDK agora vem com um arquivo de documentação resumida para facilitar a compreensão de como proceder na criação de suas Applications.

Nova metodologia de tratamento de erros

Todas as chamadas à API lançarão uma exceção contendo uma descrição, na medida do possível, do que deu errado, caso encontrem um erro. Isso inclui todas as respostas 4xx e 5xx, bem como erros do SMS, Numbers, Number Insighte Verify que podem retornar uma resposta 200 OK acompanhada de um código de erro. Todas essas exceções serão do tipo NexmoException (SubTipos NexmoSmsResponseException, NexmoNumberInsightResponseException, NexmoNumberResponseException, NexmoVerifyResponseException) ou NexmoHttpRequestException.

Existem erros semelhantes que também serão gerados nas APIs legadas.

Por trás dos bastidores

Também fizemos algumas melhorias significativas nos bastidores que serão menos relevantes para a interação com a API, mas que ainda assim podem ser interessantes.

Métodos internos de solicitação refatorados

Reestruturamos todos os métodos internos ApiRequest para torná-los mais fáceis de usar e genéricos. Você pode dar uma olhada aqui.

Observação: esses métodos não são considerados parte da API pública do SDK e estão sujeitos a alterações sem aviso prévio.

Testes unitários

Adicionamos um conjunto totalmente novo de testes unitários para evitar que algo dê errado antes do lançamento. A cobertura dos testes unitários passou de 33% na versão 4.4.0 para 87% na versão 5.0. Praticamente tudo o que não foi testado é código legado ou um arquivo de terceiros que incorporamos ao SDK.

Alterações que exigem atualização

Fizemos o possível para garantir que a transição para a versão 5.0 seja a mais tranquila possível.

As novas estruturas não devem afetar os usuários atuais do SDK, embora eu recomende que todos prestem atenção aos avisos de obsolescência. Dito isso, há algumas alterações que causam incompatibilidade entre as versões 4.x e 5.x das quais você deve estar ciente.

• Removemos o LibLog; assim, sem nenhuma ação por parte do desenvolvedor, os logs deixarão de se misturar com os logs do desenvolvedor.

• Novas exceções serão lançadas caso ocorra qualquer erro em uma chamada de API, o que inclui respostas 200 com códigos de erro.

Ainda tem mais por vir

Essa nova biblioteca representa uma grande mudança para o SDK do .NET, mas é apenas o começo. Temos muito mais por vir e estou ansioso para compartilhar mais novidades com vocês no futuro!

Até lá, se tiver alguma dúvida, fique à vontade para entrar em contato conosco no nosso Slack da comunidade.

Recursos

• Você pode encontrar nosso pacote NuGet aqui

• Nosso SDK é mantido no GitHub; fique à vontade para dar uma olhada, abrir um ticket caso encontre algum problema ou, quem sabe, até mesmo contribuir com o projeto!