Swagger - 如何删除 XML 作为格式选项；只想要 JSON 格式

问题描述

我正在构建一个 WEB API 项目，似乎我无法删除默认为 XML 格式的 Swagger 的默认设置。我尝试删除 AddXmlSerializerFormatters 方法调用，但此时我的控制器响应失败。任何人都有一种简单的方法来消除 Web API 和 Swagger 中的所有 XML 并且只支持 JSON？下面是我当前在 Startup.cs 中的代码

services.AddMvc(options =>
                {
                    options.InputFormatters.RemoveType<Microsoft.AspNetCore.Mvc.Formatters.SystemTextJsonInputFormatter>();
                    options.OutputFormatters.RemoveType<Microsoft.AspNetCore.Mvc.Formatters.SystemTextJsonOutputFormatter>();
                }).AddXmlSerializerFormatters();

            services.AddControllers().AddJsonoptions(options => {
                options.JsonSerializerOptions.PropertyNamingPolicy = null;
                options.JsonSerializerOptions.DictionaryKeyPolicy = null;

            });

控制器代码：

[HttpGet]
        [Route("/companies")]
        [ValidateModelState]
        [SwaggerOperation("GetCompanies")]
        public virtual IActionResult GetCompanies()
        {
            ICompanyRepository _companyRespository = new CompaniesRepository();
            List<Company> companies = _companyRespository.GetAll();
            return Ok(companies);
        }

解决方法

您的控制器类有 [Produces("application/json")] 属性吗？

来自Get started with Swashbuckle and ASP.NET Core：

用属性标记模型，在 System.ComponentModel.DataAnnotations 命名空间，帮助驱动 Swagger 界面组件。

在 API 中添加 [Produces("application/json")] 属性 控制器。它的目的是声明控制器的动作 支持响应内容类型为 application/json。

响应内容类型下拉列表选择此内容类型作为 默认。