NetTopologySuite 2.0如何转GeoJSON对象用于Web API并适配Swagger？

你碰到的这个场景其实是很多用NTS做地理数据Web API的开发者都会遇到的——默认的GeoJsonWriter输出字符串，但我们需要强类型对象来让Swagger生成清晰的模型。其实不用从零手写DTO，这里有两个更优雅的解决方案：

方案1：直接返回NTS Geometry类型，配置Json转换器（推荐） #

NTS官方提供了针对主流Json序列化库的扩展包，让你可以直接返回Geometry对象，Web API会自动把它序列化为标准GeoJSON，同时Swagger也能识别并展示对应的模型结构。

步骤： #

1. 安装对应NuGet包：

   • 如果你用的是ASP.NET Core默认的System.Text.Json，安装NetTopologySuite.IO.JsonSystemTextJson
   • 如果你用的是Newtonsoft.Json，安装NetTopologySuite.IO.GeoJson

2. 注册Json转换器：
   在Program.cs（老版本用Startup.cs）里配置控制器的Json选项：

   // System.Text.Json 配置示例
   builder.Services.AddControllers()
       .AddJsonOptions(options =>
       {
           // 添加NTS的GeoJSON转换器工厂
           options.JsonSerializerOptions.Converters.Add(new NetTopologySuite.IO.Converters.GeoJsonConverterFactory());
       });
   
   // Newtonsoft.Json 配置示例
   builder.Services.AddControllers()
       .AddNewtonsoftJson(options =>
       {
           options.SerializerSettings.Converters.Add(new NetTopologySuite.IO.GeoJsonConverter());
       });
   

3. 修改API方法：
   现在你可以直接返回NTS的Geometry类型，不用自己手动转换DTO：

   [HttpGet]
   public Geometry GetData()
   {
       // 处理得到你的Geometry对象
       Geometry geometry = ...;
       return geometry;
   }
   

   这样Web API会输出标准GeoJSON，Swagger也会自动生成包含type和coordinates等字段的清晰模型。

方案2：自定义GeoJSON DTO（如果一定要用自定义类） #

如果你坚持要用自己的GeometryGeoJsonDto，可以基于GeoJSON规范定义DTO，再利用NTS的序列化能力完成转换：

1. 定义通用GeoJSON DTO（适配多种几何类型） #

public class GeometryGeoJsonDto
{
    [JsonPropertyName("type")]
    public string Type { get; set; }

    [JsonPropertyName("coordinates")]
    public object Coordinates { get; set; } // 用object适配Point/LineString/Polygon等不同的坐标结构
}

如果需要更严格的类型约束，可以针对不同几何类型写子类（比如PointGeoJsonDto、PolygonGeoJsonDto），但会增加代码复杂度。

2. 编写扩展方法完成转换 #

public static GeometryGeoJsonDto ToDto(this Geometry geometry)
{
    var geoJsonWriter = new NetTopologySuite.IO.GeoJsonWriter();
    var geoJsonString = geoJsonWriter.Write(geometry);
    // 用对应的Json库反序列化为你的DTO
    return JsonSerializer.Deserialize<GeometryGeoJsonDto>(geoJsonString);
}

这种方式的缺点是Swagger展示的Coordinates是object类型，不够直观，所以方案1是更优的选择。

为什么你找不到现成的兼容DTO？ #

NTS的设计思路是通过序列化器直接处理自身的Geometry类型，而非提供一套独立的GeoJSON DTO类——因为GeoJSON的结构和NTS的几何模型是一一对应的，直接用转换器就能完成映射，既减少冗余代码，又能保证兼容性。

内容的提问来源于stack exchange，提问作者Rok