如何将.NET Swagger的字段名转换为小写？

本文共计1189个文字，预计阅读时间需要5分钟。

使用.NET Swagger将字段名转换为小写的实现方法+简介+在.NET开发Web API时，我们经常会使用Swagger来生成API文档和测试接口。然而，有时我们希望Swagger生成的字段名是小写的，而不是默认的大写。以下是一种实现方法：

1. 创建一个新的Swagger配置类，继承自`SwaggerGen.AspNetCoreCore.SwaggerGenOptions`。

2.在该类中，重写`ConfigureDefaults`方法，并使用`UseLowercaseWords`来设置字段名转换为小写。

3.在Startup类的`ConfigureServices`方法中，注册该配置类。

示例代码：

csharp

using Microsoft.AspNetCore.Builder;using Microsoft.Extensions.DependencyInjection;using Microsoft.OpenApi.Models;

public class SwaggerOptions : SwaggerGenOptions{ public SwaggerOptions() { ConfigureDefaults(default=> { default.UseLowercaseWords(); }); }}

public class Startup{ public void ConfigureServices(IServiceCollection services) { services.AddSwaggerGen(options=> { options.UseLowercaseWords(); }); }

public void Configure(IApplicationBuilder app, IWebHostEnvironment env) { if (env.IsDevelopment()) { app.UseDeveloperExceptionPage(); }

app.UseRouting();

app.UseEndpoints(endpoints=> { endpoints.MapControllers(); });

app.UseSwagger(); app.UseSwaggerUI(c=> { c.SwaggerEndpoint(/swagger/v1/swagger.json, My API V1); }); }}

这样，Swagger生成的API文档中，字段名就会是小写的。

.NET Swagger 将字段变成小写的实现方法

简介

在使用.NET开发Web API时，我们经常会使用Swagger来生成API文档和测试接口。然而，有时我们希望Swagger生成的字段名是小写的，而不是按照默认的驼峰命名规则。本文将介绍如何在.NET项目中实现将字段名变成小写的方法。

实现步骤

下面是实现该需求的步骤。建议将步骤以表格的形式展示，方便小白开发者理解和操作。

步骤 操作 1. 安装 Swashbuckle.AspNetCore 包 2. 配置 Swagger 生成器 3. 自定义 Swagger 文档生成规则 4. 更新 Startup.cs 文件 5. 启动应用程序并查看 Swagger 文档

下面让我来详细介绍每一步的具体操作和使用的代码。

步骤 1：安装 Swashbuckle.AspNetCore 包

首先，在你的 .NET 项目中安装 Swashbuckle.AspNetCore 包。可以使用 NuGet 包管理器控制台或通过 Visual Studio 的 NuGet 包管理器进行安装。

Install-Package Swashbuckle.AspNetCore

步骤 2：配置 Swagger 生成器

在 Startup.cs 文件中的 ConfigureServices 方法中添加以下代码来配置 Swagger 生成器。

services.AddSwaggerGen();

步骤 3：自定义 Swagger 文档生成规则

在 Startup.cs 文件中的 ConfigureServices 方法中添加以下代码来自定义 Swagger 文档生成规则。

services.Configure<SwaggerGenOptions>(options => { options.CustomSchemaIds(type => type.ToString()); // 默认使用类型名称作为 SchemaId options.DocumentFilter<LowerCaseDocumentFilter>(); // 自定义文档过滤器 });

步骤 4：更新 Startup.cs 文件

在 Startup.cs 文件中的 Configure 方法中添加以下代码来启用 Swagger 中间件和生成 Swagger JSON。

app.UseSwagger(); app.UseSwaggerUI(c => { c.SwaggerEndpoint("/swagger/v1/swagger.json", "API V1"); });

步骤 5：启动应用程序并查看 Swagger 文档

现在你可以启动应用程序并导航到 Swagger UI 页面（通常是 localhost:5000/swagger/index.html）。在 Swagger 文档中，你将看到生成的 API 文档和测试接口。

代码注释解释

下面对上述代码进行注释解释，方便小白开发者理解每一行代码的作用。

// 步骤 2：配置 Swagger 生成器 services.AddSwaggerGen();

该代码用于配置 Swagger 生成器，使其能够生成 Swagger 文档。

// 步骤 3：自定义 Swagger 文档生成规则 services.Configure<SwaggerGenOptions>(options => { options.CustomSchemaIds(type => type.ToString()); // 默认使用类型名称作为 SchemaId options.DocumentFilter<LowerCaseDocumentFilter>(); // 自定义文档过滤器 });

该代码用于自定义 Swagger 文档生成规则。通过 CustomSchemaIds 方法，我们指定使用类型名称作为 SchemaId，而不是默认的完全限定名称。通过 DocumentFilter 方法，我们添加了自定义的文档过滤器 LowerCaseDocumentFilter，用于将字段名变成小写。

// 步骤 4：更新 Startup.cs 文件 app.UseSwagger(); app.UseSwaggerUI(c => { c.SwaggerEndpoint("/swagger/v1/swagger.json", "API V1"); });

该代码用于添加 Swagger 中间件并生成 Swagger JSON。通过调用 UseSwaggerUI 方法，我们指定 Swagger UI 页面显示的 API 文档的终结点。

总结

通过按照上述步骤和代码的操作，你可以实现将字段名变成小写的需求。使用 Swashbuckle.AspNetCore 包和自定义文档过滤器，可以方便地控制 Swagger 生成的 API 文档的展示形式。

希望本文对你理解和实现“.NET Swagger把字段变成小写”有所帮助。祝你编码愉快！