Swagger -配置JSON文件C#_如何从配置文件设置swagger配置属性_Laravel swagger api-未找到docs json文件 - 腾讯云开发者社区

Swagger -配置JSON文件C#

Swagger（现称为OpenAPI Specification）是一种用于描述、生成、消费和可视化RESTful web服务的工具集。在C#中配置Swagger通常涉及以下几个步骤：

1. 安装Swagger相关NuGet包

首先，你需要在你的ASP.NET Core项目中安装Swagger相关的NuGet包。最常用的是Swashbuckle.AspNetCore。

dotnet add package Swashbuckle.AspNetCore

2. 配置Swagger生成器

在你的Startup.cs文件中配置Swagger生成器。通常在ConfigureServices和Configure方法中进行配置。

在`ConfigureServices`中添加Swagger服务：

public void ConfigureServices(IServiceCollection services)
{
    // 其他服务配置...

    services.AddSwaggerGen(c =>
    {
        c.SwaggerDoc("v1", new OpenApiInfo { Title = "Your API Title", Version = "v1" });

        // 如果你有XML注释文件，可以启用它们
        c.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, "YourProjectName.xml"));
    });
}

在`Configure`中启用Swagger中间件：

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", "Your API Title V1");
    });
}

3. 添加XML注释（可选但推荐）

为了使Swagger UI显示详细的API文档，建议添加XML注释。

在项目属性中启用XML文档文件生成：

右键点击项目 -> 属性 -> 生成 -> 勾选“XML文档文件”。

确保生成的XML文件路径正确，并在Swagger配置中引用它（如上面的IncludeXmlComments所示）。

4. 自定义Swagger UI（可选）

你可以通过传递一个配置对象给UseSwaggerUI方法来自定义Swagger UI的外观和行为。

app.UseSwaggerUI(c =>
{
    c.SwaggerEndpoint("/swagger/v1/swagger.json", "Your API Title V1");
    c.DisplayRequestDuration(); // 显示每个请求的处理时间
    c.DocExpansion(Swashbuckle.AspNetCore.SwaggerUI.DocExpansion.None); // 控制文档的展开状态
});