farukaf / brasilapi-dotnet

Um SDK/Client .Net para BrasilAPI

Brasil API

Vamos transformar o Brasil em uma API?

Atenção

Este é um SDK/Client .Net para BrasilAPI!

Como utilizar

• NuGet disponível: https://www.nuget.org/packages/BrasilAPI

Utilização com injeção de dependencia

Realizar a injeção na sua camada de service. ConfigureServices na classe Startup.cs ou Program.cs como abaixo.

Exemplo da implementação no Program.cs

using SDKBrasilAPI;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddBrasilApi();

Utilização em um endpoint minimal API

app.MapGet("/ParticipantesPIX", async (IBrasilAPI brasilAPI) =>
{ 
    return await brasilAPI.ParticipantesPIX();
});

Utilização em uma controller MVC

[ApiVersion("2")]
[Route("v{version:apiVersion}/[controller]")]
public class ServiceController : ControllerBase
{ 
	private readonly IBrasilAPI _brasilAPI;

	public ServiceController(IBrasilAPI brasilAPI)
	{
		_brasilAPI = brasilAPI; 
	}
}

Utilização sem injeção de dependencia (não recomendado)

using SDKBrasilAPI;

Exemplo para receber a lista de cidades com DDD 17:

using (var brasilAPI = new BrasilAPI())
{
  var response = await brasilAPI.DDD(17);
  foreach (var city in response.Cities)
  {
    Console.WriteLine(city);
  }
}

Exemplo de como tratar erros:

//cnpj inválido
var cnpj = "00.000.000/0001-00";

try
{
  using (var brasilAPI = new BrasilAPI())
  {
    var response = await brasilAPI.CNPJ(cnpj);
  }
}
catch (BrasilAPIException ex)
{
  //Codigo HTTP de erro
  Console.WriteLine(ex.Code);
  //Mensagem de erro: CNPJ 00.000.000/0001-00 inválido.
  Console.WriteLine(ex.Message);
  //Conteudo recebido: {message:"CNPJ 00.000.000/0001-00 inválido."}
  Console.WriteLine(ex.ContentData);
  //URL gerada para a requisição
  Console.WriteLine(ex.URL);
} 

Sobre a Biblioteca

• Utilizado .Net Standard 2.0

Requisitos

• Microsoft.Extensions.DependencyInjection.Abstractions
• System.Text.Json

Pode ser utilizado a partir do seu sistema .Net Framework 4.6.1+, .Net Core 2.0+ ou Xamarin. Consulte a documentação oficial da Microsoft para mais informações.

brasilapi-dotnet's Issues

Erro ao pesquisar CEP

Olá, boa noite!

A chamada:
https://brasilapi.com.br/api/cep/v2/09726121

Retorna o erro abaixo:
{
"message": "invalid json response body at https://nominatim.openstreetmap.org/search?format=json&addressdetails=1&country=Brasil&state=SP&city=S%C3%A3o%20Bernardo%20do%20Campo&street=Rua%20Domiciano%20Rossi%20(Jd%20Ch%20Inglesa) reason: Unexpected token < in JSON at position 0",
"type": "invalid-json"
}

Adicionar nas documentações quais as exceptions cada função pode soltar

Exemplo

class MasterFileFormatCorruptException : System.Exception { ... }
class MasterFileLockedOpenException : System.Exception { ... }

public class DataBaseOperations
{
    /// <exception cref="MasterFileFormatCorruptException">
    /// Thrown when the master file is corrupted.
    /// </exception>
    /// <exception cref="MasterFileLockedOpenException">
    /// Thrown when the master file is already open.
    /// </exception>
    public static void ReadRecord(int flag)
    {
        if (flag == 1)
        {
            throw new MasterFileFormatCorruptException();
        }
        else if (flag == 2)
        {
            throw new MasterFileLockedOpenException();
        }
        ...
    }
}

Parsing de JSON com System.Text.Json

Olá a todos.

Parabéns pelo excelente trabalho realizado.

Gostaria de propor a mudança da dependência Newtonsoft.Json para System.Text.Json nativo do .NET.

Cabe ressaltar que esta implementação não seria compatível com .NET Standart, se vier a ser considerada.

ISBN endpoint

Olá! Parabéns pelo excelente trabalho!

Gostaria de informar que o projeto oficial agora inclui um endpoint para ISBN, que fornece várias informações sobre livros a partir do número ISBN. Não tenho certeza se essa funcionalidade foi adicionada recentemente ou se existe algum motivo específico para que ela não estivesse disponível antes.

Essa issue tem mais o objetivo de informar do que qualquer outra coisa, considerando que a implementação desse endpoint parece ser relativamente simples.

Abç

Vincular readme no pacote nuget

https://devblogs.microsoft.com/nuget/add-a-readme-to-your-nuget-package/#add-a-readme-to-your-package

Sugestão de implementação

Imagino que você tenha escrito todo o código, mas se quiser dá para gerar a lib de maneira mais simplificada. Como a documentação é feita usando swagger dá para tentar usar um swagger-codegen para gerar a biblioteca automaticamente.

E se quiser acho que é possível deixar mais automático, pode tentar configurar este repo para ficar ouvindo as alterações do repo oficial e toda vez que tiver um novo commit na master você gera uma nova versão da lib por meio do github action