在开发ASP.NET Core Web API时，经常需要设置响应输出的Json数据格式。Json是一种常用的数据交换格式，而ASP.NET Core提供了两种灵活的方式来自定义Json数据格式的输出。本文将介绍这两种方式，并提供示例代码。
1. 使用JsonOptions配置Json输出格式
ASP.NET Core提供了JsonOptions类，可以通过配置其属性来设置Json数据的输出格式。以下是设置Json数据格式的常用属性：
- Encoder: 指定用于编码和解码Json数据的字符编码，默认为UTF-8。
- IgnoreNullValues: 是否忽略空值。当设置为true时，输出的Json数据中将不包含空键值对，默认为false。
- WriteIndented: 是否缩进Json数据。当设置为true时，输出的Json数据将进行缩进格式化，默认为false。
可以在Startup类的ConfigureServices方法中配置JsonOptions：
public void ConfigureServices(IServiceCollection services)
{
services.AddControllers()
.AddJsonOptions(options =>
{
options.JsonSerializerOptions.IgnoreNullValues = true;
options.JsonSerializerOptions.WriteIndented = true;
});
}
在以上示例中，通过设置JsonOptions的IgnoreNullValues属性为true和WriteIndented属性为true，实现了忽略空值和缩进格式化输出的功能。
2. 使用JsonPropertyAttribute自定义Json输出格式
如果只需要对某个属性进行特定的Json输出格式设置，可以使用JsonPropertyAttribute特性。
例如，某个实体类定义如下：
public class Person
{
[JsonPropertyName("Name")]
public string FullName { get; set; }
[JsonIgnore]
public int Age { get; set; }
public string Email { get; set; }
}
在以上示例中，使用JsonPropertyAttribute将FullName属性重命名为Name，并使用JsonIgnoreAttribute忽略Age属性。Email属性没有使用任何特性，将按照默认规则进行Json输出。
总结
本文介绍了ASP.NET Core Web API设置响应输出的Json数据格式的两种方式。通过配置JsonOptions或使用JsonPropertyAttribute，可以方便地自定义Json数据的输出格式。无论是全局设置或对特定属性进行设置，ASP.NET Core提供了灵活的工具来满足开发者的需求。现在，你可以根据需要选择最合适的方式来设置Json输出格式了。
本文来自极简博客，作者：落日之舞姬，转载请注明原文链接：ASP.NET Core Web API设置响应输出的Json数据格式的两种方式
