blocks|key|1125482|text|创建一个操作筛选器，该筛选器可用于要添加该功能的任何操作。我在URLWebAPI2(而不是核心)中实现了同样的目标，它使用DelegatingHandler检查请求并根据prettify=true查询参数更新json格式化器的缩进|type|unstyled|depth|inlineStyleRanges|offset|length|style|CODE|entityRanges|data|1125483|下面是如何使用委托处理程序完成此操作的|1125484|///+<summary>
///+Custom+handler+to+allow+pretty+print+json+results.
///+</summary>
public+class+PrettyPrintJsonHandler+:+DelegatingHandler+{
++++const+string+prettyPrintConstant+=+"pretty";
++++MediaTypeHeaderValue+contentType+=+MediaTypeHeaderValue.Parse("application/json;charset=utf-8");
++++private+System.Web.Http.HttpConfiguration+httpConfig;
++++///+<summary>
++++///+Initializes+a+new+instance+of+the+<seealso+cref="PrettyPrintJsonHandler"/>+class+with+an+HTTP+Configuration.
++++///+</summary>
++++///+<param+name="config"></param>
++++public+PrettyPrintJsonHandler(System.Web.Http.HttpConfiguration+config)+{
++++++++this.httpConfig+=+config;
++++}

++++protected+override+async+Task<HttpResponseMessage>+SendAsync(HttpRequestMessage+request,+System.Threading.CancellationToken+cancellationToken)+{
++++++++var+canPrettyPrint+=+checkQuery(request.RequestUri.Query);
++++++++var+jsonFormatter+=+httpConfig.Formatters.JsonFormatter;
++++++++jsonFormatter.Indent+=+canPrettyPrint;

++++++++var+response+=+await+base.SendAsync(request,+cancellationToken);

++++++++if+(canPrettyPrint+&&+response.Content+!=+null)+{
++++++++++++response.Content.Headers.ContentType+=+contentType;
++++++++}

++++++++return+response;
++++}

++++private+bool+checkQuery(string+queryString)+{
++++++++var+canPrettyPrint+=+false;
++++++++if+(!string.IsNullOrWhiteSpace(queryString))+{
++++++++++++var+prettyPrint+=+QueryString.Parse(queryString)[prettyPrintConstant];
++++++++++++canPrettyPrint+=+!string.IsNullOrWhiteSpace(prettyPrint)+&&+Boolean.TryParse(prettyPrint,+out+canPrettyPrint)+&&+canPrettyPrint;
++++++++}
++++++++return+canPrettyPrint;
++++}
}|code-block|syntax|javascript|1125485|它是在安装过程中作为全局消息处理程序添加的。|1125486|同样的概念也可以应用于操作筛选器。|1125487|entityMap^0|1P|H|2D|D|0|0|0|0|0^^$0|@$1|2|3|4|5|6|7|S|8|@$9|T|A|U|B|C]|$9|V|A|W|B|C]]|D|@]|E|$]]|$1|F|3|G|5|6|7|X|8|@]|D|@]|E|$]]|$1|H|3|I|5|J|7|Y|8|@]|D|@]|E|$K|L]]|$1|M|3|N|5|6|7|Z|8|@]|D|@]|E|$]]|$1|O|3|P|5|6|7|10|8|@]|D|@]|E|$]]|$1|Q|3|-4|5|6|7|11|8|@]|D|@]|E|$]]]|R|$]]

Create an action filter that can be used on which ever action you want to add that functionality. I had achieved the same in Asp.Net Web API 2 (not core) using a <code>DelegatingHandler</code> that would inspect the request and update the json formatter's indent based on <code>prettify=true</code> query parameter in the URL

Here is how it was done with the delegating handler

<pre><code>/// &lt;summary&gt;
/// Custom handler to allow pretty print json results.
/// &lt;/summary&gt;
public class PrettyPrintJsonHandler : DelegatingHandler {
 const string prettyPrintConstant = "pretty";
 MediaTypeHeaderValue contentType = MediaTypeHeaderValue.Parse("application/json;charset=utf-8");
 private System.Web.Http.HttpConfiguration httpConfig;
 /// &lt;summary&gt;
 /// Initializes a new instance of the &lt;seealso cref="PrettyPrintJsonHandler"/&gt; class with an HTTP Configuration.
 /// &lt;/summary&gt;
 /// &lt;param name="config"&gt;&lt;/param&gt;
 public PrettyPrintJsonHandler(System.Web.Http.HttpConfiguration config) {
 this.httpConfig = config;
 }

 protected override async Task&lt;HttpResponseMessage&gt; SendAsync(HttpRequestMessage request, System.Threading.CancellationToken cancellationToken) {
 var canPrettyPrint = checkQuery(request.RequestUri.Query);
 var jsonFormatter = httpConfig.Formatters.JsonFormatter;
 jsonFormatter.Indent = canPrettyPrint;

 var response = await base.SendAsync(request, cancellationToken);

 if (canPrettyPrint &amp;&amp; response.Content != null) {
 response.Content.Headers.ContentType = contentType;
 }

 return response;
 }

 private bool checkQuery(string queryString) {
 var canPrettyPrint = false;
 if (!string.IsNullOrWhiteSpace(queryString)) {
 var prettyPrint = QueryString.Parse(queryString)[prettyPrintConstant];
 canPrettyPrint = !string.IsNullOrWhiteSpace(prettyPrint) &amp;&amp; Boolean.TryParse(prettyPrint, out canPrettyPrint) &amp;&amp; canPrettyPrint;
 }
 return canPrettyPrint;
 }
}
</code></pre>

which was added as a global message handler during setup.

The same concept could be applied to an action filter.

blocks|key|1441486|text|感谢@Nkosi评论，我找到了解决方案。下面是动作过滤器的代码，它查找'prettify‘参数并将缩进添加到输出JSON。如果省略该参数，则还会添加缩进。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|1441487|public+class+OutputFormatActionFilter+:+IActionFilter
{
++++public+void+OnActionExecuting(ActionExecutingContext+context)
++++{
++++}

++++public+void+OnActionExecuted(ActionExecutedContext+context)
++++{
++++++++var+actionResult+=+context.Result+as+ObjectResult;
++++++++if+(actionResult+==+null)+return;

++++++++var+paramObj+=+context.HttpContext.Request.Query["prettify"];
++++++++var+isPrettify+=+string.IsNullOrEmpty(paramObj)+%7C%7C+bool.Parse(paramObj);

++++++++if+(!isPrettify)+return;

++++++++var+settings+=+new+JsonSerializerSettings+{+Formatting+=+Formatting.Indented+};

++++++++actionResult.Formatters.Add(new+JsonOutputFormatter(settings,+ArrayPool<char>.Shared));
++++}
}|code-block|syntax|javascript|1441488|entityMap^0|0|0^^$0|@$1|2|3|4|5|6|7|I|8|@]|9|@]|A|$]]|$1|B|3|C|5|D|7|J|8|@]|9|@]|A|$E|F]]|$1|G|3|-4|5|6|7|K|8|@]|9|@]|A|$]]]|H|$]]

Thank to @Nkosi comment, I've found the solution. Below is a code of the action filter that looks for 'prettify' parameter and adds indentation to output JSON. If the parameter omitted, indentation is also added.

<pre><code>public class OutputFormatActionFilter : IActionFilter
{
 public void OnActionExecuting(ActionExecutingContext context)
 {
 }

 public void OnActionExecuted(ActionExecutedContext context)
 {
 var actionResult = context.Result as ObjectResult;
 if (actionResult == null) return;

 var paramObj = context.HttpContext.Request.Query["prettify"];
 var isPrettify = string.IsNullOrEmpty(paramObj) || bool.Parse(paramObj);

 if (!isPrettify) return;

 var settings = new JsonSerializerSettings { Formatting = Formatting.Indented };

 actionResult.Formatters.Add(new JsonOutputFormatter(settings, ArrayPool&lt;char&gt;.Shared));
 }
}
</code></pre>

I'm working on REST service based on ASP.NET Core Web API and want to add a parameter 'prettify' to my endpoint so that response json will be formatted with indentation and readable in web browser.

My question - how can I change JSON formatting per controller method in ASP.WEB API Core application?

Appreciate you help.

Asp WebApi: Prettify ActionResult JSON output

翻译质量差，导致语言生硬或混乱。

没有提供实际的解决方法或示例。

解答不清晰，无法理解或解决问题。

页面排版不美观，阅读体验差。

文章

问答

视频

教程

学习中心

腾讯云实验室

直播

竞赛

腾讯云代码分析专区

腾讯iOA零信任安全管理系统专区

腾讯云架构师技术同盟交流圈

腾讯云数据库专区

腾讯云智能顾问专区

腾讯云原生专区

腾讯混元专区

腾讯云TCE专区

腾讯云Lighthouse专区

腾讯云HAI专区

腾讯云Edgeone专区

腾讯云存储专区

腾讯云智能专区

腾讯轻联专区 

腾讯云开发专区

TAPD专区

腾讯轻量云游戏服专区

腾讯云最具价值专家

腾讯云架构师技术同盟

腾讯云创作之星

腾讯云开发者先锋

腾讯云代码助手

云原生构建

TAPD 敏捷项目管理

Cloud Studio

SDK中心

API中心

命令行工具

涵盖代码开发、场景应用、自动测试全流程，助你从零构建专属AI助手

一站式MCP教程库，解锁AI应用新玩法

聚焦“写作效率、视觉美观与运行性能”三方面进行全面升级，为您提供更高效、稳定的创作环境

社区富文本&Markdown编辑器全新改版上线，欢迎大家体验!

诚挚邀请您参与本次调研，分享您的真实使用感受与建议。您的反馈至关重要，感谢您的支持与参与！

社区新版编辑器体验调研

我在基于ASP.NET核心Web API的REST服务上工作，并想在我的端点添加一个参数'prettify‘，这样响应json就会被缩进格式化，并在web浏览器中可读。我的问题--如何在ASP.WEB应用程序接口核心应用程序中更改每个控制器方法的JSON格式？谢谢你的帮助。

问Asp :美化ActionResult WebApi输出
EN

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问Asp :美化ActionResult WebApi输出EN