Geographic Encoding API 技术文档

1. 安装指南

要使用 Generic C# Geocoding API，您需要通过 NuGet 包管理器进行安装。在您的项目中执行以下命令以安装核心库：

Install-Package Geocoding.Core

接下来，根据需要选择并安装以下提供者的包：

Install-Package Geocoding.Google
Install-Package Geocoding.MapQuest
Install-Package Geocoding.Microsoft
Install-Package Geocoding.Yahoo
Install-Package Geocoding.Here

2. 项目的使用说明

Generic C# Geocoding API 提供了一个模型和接口，用于与五种流行的地理编码提供者进行通信。以下是一个简单使用示例：

简单示例

IGeocoder geocoder = new GoogleGeocoder() { ApiKey = "this-is-my-google-api-key" };
IEnumerable<Address> addresses = await geocoder.GeocodeAsync("1600 pennsylvania ave washington dc");
Console.WriteLine("格式化地址: " + addresses.First().FormattedAddress); // 格式化地址: 1600 Pennsylvania Ave SE, Washington, DC 20003, USA
Console.WriteLine("坐标: " + addresses.First().Coordinates.Latitude + ", " + addresses.First().Coordinates.Longitude); // 坐标: 38.8791981, -76.9818437

该 API 还支持从经纬度坐标获取地址信息（即反向地理编码）：

IGeocoder geocoder = new YahooGeocoder("consumer-key", "consumer-secret");
IEnumerable<Address> addresses = await geocoder.ReverseGeocodeAsync(38.8976777, -77.036517);

使用特定提供者数据

GoogleGeocoder geocoder = new GoogleGeocoder();
IEnumerable<GoogleAddress> addresses = await geocoder.GeocodeAsync("1600 pennsylvania ave washington dc");

var country = addresses.Where(a => !a.IsPartialMatch).Select(a => a[GoogleAddressType.Country]).First();
Console.WriteLine("国家: " + country.LongName + ", " + country.ShortName); // 国家: United States, US

Microsoft 和 Yahoo 的实现也各自提供了自己的地址类，分别是 BingAddress 和 YahooAddress。

3. 项目API使用文档

API 返回经纬度坐标和标准化地址信息，这些信息可以用于地址验证、实时映射用户输入的地址、距离计算等。

• GeocodeAsync：根据提供的地址字符串进行地理编码。
• ReverseGeocodeAsync：根据提供的经纬度坐标进行反向地理编码。

每个提供者可能还有特定的方法和属性，用于访问特定于该提供者的数据。

4. 项目安装方式

除了通过 NuGet 安装外，您还可以从源代码构建项目：

dotnet restore
dotnet build

为了更好的开发体验，推荐使用 Visual Studio Code 编辑器，该编辑器支持跨平台且开源。如果您使用的是 Windows 系统，也可以在 Visual Studio 中打开解决方案并进行构建。

运行服务测试时，您需要为每个服务生成 API 密钥，并在测试项目的 settings-override.json 文件中配置这些密钥。之后，您应该能够运行测试。