CoreZipCode 1.1.0
See the version list below for details.
dotnet add package CoreZipCode --version 1.1.0
NuGet\Install-Package CoreZipCode -Version 1.1.0
<PackageReference Include="CoreZipCode" Version="1.1.0" />
paket add CoreZipCode --version 1.1.0
#r "nuget: CoreZipCode, 1.1.0"
// Install CoreZipCode as a Cake Addin
#addin nuget:?package=CoreZipCode&version=1.1.0
// Install CoreZipCode as a Cake Tool
#tool nuget:?package=CoreZipCode&version=1.1.0
Overview
Normaly we must implement ZipCode or Postcode services every time in each new software we create. Well this package is for keep you DRY and eliminate the necessity to implement ZipCode or Postcode services over and over.
Also this package could be used for easily implements address services to yours Microsoft .Net Core based software.
And the CoreZipCode was designed to be easily extensible, and if you want, implement your own address services, you only must override the API calls methods.
We follow the Semantic Versioning, so check the package compatibility before use it.
Get Started
Well, you can download the code and build it by yourself or you can install by Nuget package in: CoreZipCode Package.
Just in case if you doesn't want leave GitHub at this moment:
dotnet add package CoreZipCode
After you decide how you'll get the CoreZipCode, just inject (e.g.: Simple Injector) and use it.
using CoreZipCode.Interfaces;
namespace YourProject
{
public YourClass
{
private readonly ZipCodeBaseService _coreZipCode;
public YourClass(ZipCodeBaseService coreZipCode)
{
_coreZipCode = coreZipCode;
}
public void YourMethod()
{
var addressByZipCode = _coreZipCode.Execute("14810100");
var zipCodeByAddress = _coreZipCode.Execute("sp", "araraquara", "barão do rio");
// Generic type return was added in version 1.1.0
var addressByZipCodeObject = _coreZipCode.GetAddress<ViaCepAddress>("14810100");
var zipCodeByAddressObjectList = _coreZipCode.ListAddresses<ViaCepAddress>("sp", "araraquara", "barão do rio");
}
// Async methods introduced in 1.1.0
public async void YourMethodAsync()
{
var addressByZipCode = await _coreZipCode.ExecuteAsync("14810100");
var zipCodeByAddress = await _coreZipCode.ExecuteAsync("sp", "araraquara", "barão do rio");
// Generic type return.
var addressByZipCodeObject = await _coreZipCode.GetAddressAsync<ViaCepAddress>("14810100");
var zipCodeByAddressObjectList = await _coreZipCode.ListAddressesAsync<ViaCepAddress>("sp", "araraquara", "barão do rio");
}
}
}
The ViaCepAddress
POCO class is the type for returned JSON from ViaCep brazilian service. So you will must to implement the POCO class for your new service.
Extending CoreZipCode
Also you can extends ZipCodeBaseService
abstract class and create your own implementation of your prefered address service. Like below:
using CoreZipCode.Interfaces;
namespace CoreZipCode.Services.YourService
{
public class YourService : ZipCodeBaseService
{
public override string SetZipCodeUrl(string zipcode)
{
// You can implement some validation method here.
return $"https://yourservice.com/{zipcode}/json/";
}
public override string SetZipCodeUrlBy(string state, string city, string street)
{
// You can implement some validation method here.
return $"https://yourservice.com/{state}/{city}/{street}/json/";
}
}
}
NOTE: Same principles are used to extends postcode lookups (
PostCodeBaseService
).
Available Services
Below a list of available services out-of-the-box address by zipcode lookup services.
Service | Country | Queries Limit |
---|---|---|
ViaCep | Brazil | 300 by 15 minutes |
SmartyStreets | USA | 250 by month |
Below a list of available services out-of-the-box postcodes lookup services.
Service | Country | Queries Limit |
---|---|---|
Postcodes | United Kingdom | Unknown |
Postal Pin Code | India | Unknown |
Contributing
Thank you for considering contributing to the CodeZipCore! Just see our Contributing Guide.
Code of Conduct
In order to ensure that the CodeZipCore community is welcoming to all, please review and abide by the Code of Conduct.
Security Vulnerabilities
If you discover any security vulnerability within CoreZipCode, please create a vulnerability issue. All security vulnerabilities will be promptly addressed.
License
The CoreZipCode is open-sourced software licensed under the MIT license.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- Newtonsoft.Json (>= 12.0.1)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.