-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #26 from guibranco/develop
Update README.md
- Loading branch information
Showing
1 changed file
with
86 additions
and
80 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,81 +1,87 @@ | ||
| # ViaCEP | ||
|
|
||
| A .NET client wrapper for both .NET Core & .NET Framework projects of [Via CEP API](https://viacep.com.br) | ||
|
|
||
|  | ||
|
|
||
| ## CI/CD | ||
|
|
||
| [](https://ci.appveyor.com/project/guibranco/9jnsy1e08jhyxl7j) | ||
| [](https://www.nuget.org/packages/ViaCEP/) | ||
| [](https://www.nuget.org/packages/ViaCEP/) | ||
| [](https://github.com/guibranco/ViaCEP) | ||
| [](https://github.com/guibranco/ViaCEP) | ||
|
|
||
| ## Code Quality | ||
|
|
||
| [](https://www.codacy.com/manual/guilherme_9/ViaCEP?utm_source=github.com&utm_medium=referral&utm_content=guibranco/ViaCEP&utm_campaign=Badge_Grade) | ||
| [](https://codecov.io/gh/guibranco/ViaCEP) | ||
| [](https://sonarcloud.io/dashboard?id=guibranco_ViaCEP) | ||
| [](https://sonarcloud.io/dashboard?id=guibranco_ViaCEP) | ||
|
|
||
| [](https://sonarcloud.io/dashboard?id=guibranco_ViaCEP) | ||
| [](https://sonarcloud.io/dashboard?id=guibranco_ViaCEP) | ||
| [](https://sonarcloud.io/dashboard?id=guibranco_ViaCEP) | ||
| [](https://sonarcloud.io/dashboard?id=guibranco_ViaCEP) | ||
|
|
||
| [](https://sonarcloud.io/dashboard?id=guibranco_ViaCEP) | ||
| [](https://sonarcloud.io/dashboard?id=guibranco_ViaCEP) | ||
| [](https://sonarcloud.io/dashboard?id=guibranco_ViaCEP) | ||
| [](https://sonarcloud.io/dashboard?id=guibranco_ViaCEP) | ||
| [](https://sonarcloud.io/dashboard?id=guibranco_ViaCEP) | ||
|
|
||
| --- | ||
|
|
||
| NuGet package: https://www.nuget.org/packages/ViaCEP | ||
|
|
||
| ```ps | ||
| Install-Package ViaCEP | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ## Usage | ||
|
|
||
| The package has two classes: | ||
|
|
||
| - [ViaCepClient](https://github.com/guibranco/ViaCEP/blob/master/ViaCEP/ViaCepClient.cs) - The main class (methods) | ||
| - [ViaCepResult](https://github.com/guibranco/ViaCEP/blob/master/ViaCEP/ViaCepResult.cs) - The result class (data) | ||
|
|
||
| This package is fully compatible with Dependency Injection. Use the interface *IViaCepClient* and the constructor with HttpClient parameter with a IHttpClientFactory instance. | ||
|
|
||
| ``` | ||
| //your DI container | ||
| services.AddHttpClient<IViaCepClient, ViaCepClient>(client =>{ | ||
| # ViaCEP | ||
|
|
||
| A .NET client wrapper for both .NET Core & .NET Framework projects of [Via CEP API](https://viacep.com.br) | ||
|
|
||
|  | ||
|
|
||
| ## CI/CD | ||
|
|
||
| [](https://ci.appveyor.com/project/guibranco/9jnsy1e08jhyxl7j) | ||
| [](https://www.nuget.org/packages/ViaCEP/) | ||
| [](https://www.nuget.org/packages/ViaCEP/) | ||
| [](https://github.com/guibranco/ViaCEP) | ||
| [](https://github.com/guibranco/ViaCEP) | ||
|
|
||
| ## Code Quality | ||
|
|
||
| [](https://www.codacy.com/manual/guilherme_9/ViaCEP?utm_source=github.com&utm_medium=referral&utm_content=guibranco/ViaCEP&utm_campaign=Badge_Grade) | ||
| [](https://codecov.io/gh/guibranco/ViaCEP) | ||
| [](https://sonarcloud.io/dashboard?id=guibranco_ViaCEP) | ||
| [](https://sonarcloud.io/dashboard?id=guibranco_ViaCEP) | ||
|
|
||
| [](https://sonarcloud.io/dashboard?id=guibranco_ViaCEP) | ||
| [](https://sonarcloud.io/dashboard?id=guibranco_ViaCEP) | ||
| [](https://sonarcloud.io/dashboard?id=guibranco_ViaCEP) | ||
| [](https://sonarcloud.io/dashboard?id=guibranco_ViaCEP) | ||
|
|
||
| [](https://sonarcloud.io/dashboard?id=guibranco_ViaCEP) | ||
| [](https://sonarcloud.io/dashboard?id=guibranco_ViaCEP) | ||
| [](https://sonarcloud.io/dashboard?id=guibranco_ViaCEP) | ||
| [](https://sonarcloud.io/dashboard?id=guibranco_ViaCEP) | ||
| [](https://sonarcloud.io/dashboard?id=guibranco_ViaCEP) | ||
|
|
||
| --- | ||
|
|
||
| ## Installation | ||
|
|
||
| Download the latest zip file from the [Release pages](https://github.com/guibranco/ViaCEP/releases) or simple install from [NuGet](https://www.nuget.org/packages/ViaCEP) package manager | ||
|
|
||
| NuGet URL: https://www.nuget.org/packages/ViaCEP | ||
|
|
||
| NuGet installation via *Package Manager Console*: | ||
|
|
||
| ```ps | ||
| Install-Package ViaCEP | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ## Usage | ||
|
|
||
| The package has two classes: | ||
|
|
||
| - [ViaCepClient](https://github.com/guibranco/ViaCEP/blob/master/ViaCEP/ViaCepClient.cs) - The main class (methods) | ||
| - [ViaCepResult](https://github.com/guibranco/ViaCEP/blob/master/ViaCEP/ViaCepResult.cs) - The result class (data) | ||
|
|
||
| This package is fully compatible with Dependency Injection. Use the interface *IViaCepClient* and the constructor with HttpClient parameter with a IHttpClientFactory instance. | ||
|
|
||
| ``` | ||
| //your DI container | ||
| services.AddHttpClient<IViaCepClient, ViaCepClient>(client =>{ | ||
| client.BaseAddress = new Uri("https://viacep.com.br/"); | ||
| }) | ||
| ``` | ||
|
|
||
| You can search using the zip code/postal code (AKA CEP) or using the address data (state initials - UF, city name and location name - street, avenue, park, square). Both methods support async and sync! | ||
|
|
||
| ## Querying by zip code / postal code (single result) | ||
|
|
||
| ```cs | ||
| var result = new ViaCepClient().Search("01234567"); //searches for the postal code 01234-567 | ||
| var address = result.Address; | ||
| var neighborhood = result.Neighborhood | ||
| //do what you need with 'result' instance of ViaCEPResult. | ||
| ``` | ||
|
|
||
| ## Querying by address (list result) | ||
|
|
||
| ```cs | ||
| var results = new ViaCepClient().Search("SP", "São Paulo", "Avenida Paulista"); //search for the Avenida Paulista in São Paulo / SP | ||
| foreach(var result in results){ | ||
| var address = result.Address; | ||
| var neighborhood = result.Neighborhood; | ||
| var zipCode = result.ZipCode; | ||
| //do what you need with 'result' instance of ViaCEPResult. | ||
| } | ||
| ``` | ||
| }) | ||
| ``` | ||
|
|
||
| You can search using the zip code/postal code (AKA CEP) or using the address data (state initials - UF, city name and location name - street, avenue, park, square). Both methods support async and sync! | ||
|
|
||
| ## Querying by zip code / postal code (single result) | ||
|
|
||
| ```cs | ||
| var result = new ViaCepClient().Search("01234567"); //searches for the postal code 01234-567 | ||
| var address = result.Address; | ||
| var neighborhood = result.Neighborhood | ||
| //do what you need with 'result' instance of ViaCEPResult. | ||
| ``` | ||
|
|
||
| ## Querying by address (list result) | ||
|
|
||
| ```cs | ||
| var results = new ViaCepClient().Search("SP", "São Paulo", "Avenida Paulista"); //search for the Avenida Paulista in São Paulo / SP | ||
| foreach(var result in results){ | ||
| var address = result.Address; | ||
| var neighborhood = result.Neighborhood; | ||
| var zipCode = result.ZipCode; | ||
| //do what you need with 'result' instance of ViaCEPResult. | ||
| } | ||
| ``` |