Swaggerの Web画面に表示されるバージョンを変える

ASPNET Core Web API プロジェクトで、「OpenAPI サポートを有効にする」にチェックがある状態で作成したプロジェクトには、デフォルトで含まれている Swaggerの、Web画面にバージョンを表示する、サンプルを作りしました。
ソースコードはGitHubで公開しています。

ソースコード構成

ASPNET Core Web API テンプレートから、変更を加えたソースファイル。

ソースコード変更内容を解説

/WebApplication1.csproj

パッケージバージョンに任意の値を入力。


<Project Sdk="Microsoft.NET.Sdk.Web">

  <PropertyGroup>
    <TargetFramework>net6.0</TargetFramework>
    <Nullable>enable</Nullable>
    <ImplicitUsings>enable</ImplicitUsings>
    <Version>1.0.1</Version>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="Swashbuckle.AspNetCore" Version="6.2.3" />
  </ItemGroup>

</Project>

<Nullable>enable</Nullable>

<ImplicitUsings>enable</ImplicitUsings>

</PropertyGroup>

</ItemGroup>

</Project>

/Program.cs

SwaggerDocに渡す OpenApiInfoの Versionに、パッケージバージョンの値を渡し、Swaggerの Webページにパッケージバージョンを表示する。


using Microsoft.OpenApi.Models;
using System.Diagnostics;
using System.Reflection;

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.

builder.Services.AddControllers();
// Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle
builder.Services.AddEndpointsApiExplorer();

//Swagger
builder.Services.AddSwaggerGen(c =>
{
    c.SwaggerDoc("v1", 
        new OpenApiInfo { 
            Title = Assembly.GetEntryAssembly().GetName().Name, 
            Version = "v" + FileVersionInfo.GetVersionInfo(Assembly.GetExecutingAssembly().Location).ProductVersion
    });
});

var app = builder.Build();

// Configure the HTTP request pipeline.
if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI();
}

app.UseAuthorization();

app.MapControllers();

app.Run();

using Microsoft.OpenApi.Models;

using System.Diagnostics;

using System.Reflection;

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.

builder.Services.AddControllers();

// Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle

builder.Services.AddEndpointsApiExplorer();

//Swagger

builder.Services.AddSwaggerGen(c =>

{

c.SwaggerDoc("v1",

new OpenApiInfo {

Title = Assembly.GetEntryAssembly().GetName().Name,

Version = "v" + FileVersionInfo.GetVersionInfo(Assembly.GetExecutingAssembly().Location).ProductVersion

});

var app = builder.Build();

// Configure the HTTP request pipeline.

if (app.Environment.IsDevelopment())

{

app.UseSwagger();

app.UseSwaggerUI();

}

app.UseAuthorization();

app.MapControllers();

app.Run();

Visual Studio プロジェクト

今回使った Visual Studio 2022 プロジェクトテンプレートは、ASPNET Core Web API の HTTPS用の構成無しです。