Asp.net core Web Api配置swagger中文的实现

这篇文章将为大家详细讲解有关Asp.net core Web Api配置swagger中文的实现，小编觉得挺实用的，因此分享给大家做个参考，希望大家阅读完这篇文章后可以有所收获。

Asp.net Core Web Api配置Swagger中文

前言

Swagger是一个开源工具，用于生成交互式API文档，方便开发者理解和使用API。本文将指导您如何在Asp.net Core Web Api中配置Swagger，并将其文档翻译成中文。

配置Swagger

1. 安装Swagger包

Install-Package Swashbuckle.AspNetCore

2. 注册Swagger服务

public void ConfigureServices(IServiceCollection services)
{
    services.AddSwaggerGen(c =>
    {
        c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });
    });
}

3. 添加Swagger中间件

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{          
    app.UseSwagger();
    app.UseSwaggerUI(c =>
    {
        c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
    });
}

翻译Swagger文档

1. 安装Swashbuckle.AspNetCore.SwaggerGen.Localization包

Install-Package Swashbuckle.AspNetCore.SwaggerGen.Localization

2. 添加本地化配置

public void ConfigureServices(IServiceCollection services)
{
    services.AddSwaggerGen(c =>
    {
        c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });

        c.AddSwaggerGenLocalization(options =>
        {
            options.BasePath = "Resources/SwaggerDoc/{culture}";
        });
    });
}

3. 创建中文资源文件

在项目中创建文件夹"Resources/SwaggerDoc"，并添加新的JSON文件"zh-CN.json"。

{
  "Description": "这是一个示例描述。",
  "Summary": "这是一个示例摘要。"
}

效果

访问Swagger UI时，将自动检测浏览器的语言设置，并显示相应的中文文档。如果浏览器语言设置为"zh-CN"，则将显示"zh-CN.json"中的翻译。

扩展

• 自定义翻译

手动翻译Swagger文档并更新JSON文件。

• 多语言支持

为多种语言创建JSON资源文件。

• Swagger UI主题

更改Swagger UI的主题以匹配您的网站。

总结

通过配置Swagger和本地化，您可以在Asp.net Core Web Api中生成中文的交互式API文档，提高API的可访问性和易用性。

以上就是Asp.net core Web Api配置swagger中文的实现的详细内容，更多请关注编程学习网其它相关文章！