Giter VIP home page Giter VIP logo

brasilapi-dotnet's Introduction

Brasil API

Vamos transformar o Brasil em uma API?

Atenção

Este é um SDK/Client .Net para BrasilAPI!

Como utilizar

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 People

Contributors

farukaf avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.