-
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 #46 from guibranco/feature/rename-master-to-main
Update appveyor.yml
- Loading branch information
Showing
7 changed files
with
117 additions
and
19 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
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 |
|---|---|---|
| @@ -0,0 +1,96 @@ | ||
| # ViaCEP | ||
|
|
||
| A .NET client wrapper for both .NET Core & .NET Framework projects of [Via CEP API](https://viacep.com.br) | ||
|
|
||
| [](https://github.com/guibranco/ViaCep) | ||
|
|
||
|  | ||
|
|
||
| ## CI/CD | ||
|
|
||
| | Build status | Last commit | Tests | Coverage | Code Smells | LOC | | ||
| |--------------|-------------|-------|----------|-------------|-----| | ||
| | [](https://ci.appveyor.com/project/guibranco/ViaCEP) | [](https://github.com/guibranco/ViaCEP) |  | [](https://sonarcloud.io/dashboard?id=guibranco_ViaCEP) | [](https://sonarcloud.io/dashboard?id=guibranco_ViaCEP) | [](https://sonarcloud.io/dashboard?id=guibranco_ViaCEP) | ||
|
|
||
| ## Code Quality | ||
|
|
||
| [](https://www.codacy.com/gh/guibranco/ViaCEP/dashboard?utm_source=github.com&utm_medium=referral&utm_content=guibranco/ViaCEP&utm_campaign=Badge_Grade) | ||
| [](https://www.codacy.com/gh/guibranco/ViaCEP/dashboard?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) | ||
|
|
||
| --- | ||
|
|
||
| ## Installation | ||
|
|
||
| ### Github Releases | ||
|
|
||
| [](https://github.com/guibranco/ViaCEP) [](https://github.com/guibranco/ViaCEP) | ||
|
|
||
| Download the latest zip file from the [Release](https://github.com/GuiBranco/ViaCEP/releases) page. | ||
|
|
||
| ### Nuget package manager | ||
|
|
||
| | Package | Version | Downloads | | ||
| |------------------|:-------:|:-------:| | ||
| | **ViaCEP** | [](https://www.nuget.org/packages/ViaCEP/) | [](https://www.nuget.org/packages/ViaCEP/) | | ||
|
|
||
| --- | ||
|
|
||
| ## Usage | ||
|
|
||
| The package has two classes: | ||
|
|
||
| - [ViaCepClient](https://github.com/guibranco/ViaCEP/blob/main/ViaCEP/ViaCepClient.cs): The main class (methods). | ||
| - [ViaCepResult](https://github.com/guibranco/ViaCEP/blob/main/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. | ||
|
|
||
| ```cs | ||
| //your DI container | ||
| services.AddHttpClient<IViaCepClient, ViaCepClient>(client => { client.BaseAddress = new Uri("https://viacep.com.br/"); }); | ||
|
|
||
| //then use in your domain service, handler, controller... | ||
| var viaCepClient = container.GetService<IViaCepClient>(); | ||
| var result = await viaCepClient.SearchAsync("01001000", cancellationToken); | ||
| ``` | ||
|
|
||
| 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("01001000"); //searches for the postal code 01001-000 | ||
| var address = result.Address; //Praça da Sé | ||
| var city = reuslt.City; //São Paulo | ||
| //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. | ||
| } | ||
| ``` | ||
|
|
||
| ## Changelog | ||
|
|
||
| - 2023-03-03: Update dependencies, change branch name, update logo. [@guibranco](https://github.com/guibranco) | ||
| - 2021-06-21: Update dependencies version. [@guibranco](https://github.com/guibranco) | ||
| - 2020-10-23: Add support to .NET Standard 2.0 and .NET Framework v4.6.1 and above. [@guibranco](https://github.com/guibranco) |
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
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,3 +1,3 @@ | ||
| theme: jekyll-theme-minimal | ||
| logo: https://raw.githubusercontent.com/guibranco/viacep/master/logo.png | ||
| logo: https://raw.githubusercontent.com/guibranco/viacep/main/logo.png | ||
| show_downloads: true |
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.