.net webapi 入門之註冊swagger服務

龙卷风吹毁停车场發表於2024-05-24
WebAPISwagger
1. 在 Program.cs 檔案中, var app = builder.Build(); 語句之前新增
//註冊swagger服務
builder.Services.AddSwaggerGen(m =>
{
    //第一個引數"後端提供的版本號,自己定義"
    //Title: 專案的名字
    //Version: 當前專案的版本
    m.SwaggerDoc("v1", new OpenApiInfo { Title= "swaggerTest" , Version= "v1"});
});

2. 在var app = builder.Build();語句之後新增

app.UseSwagger();
app.UseSwaggerUI(c =>
{
    //第一個引數:設定生成的json地址
    //v1 必須對應註冊swagger服務後端提供的版本號一致
    //第二個引數: 名稱
    c.SwaggerEndpoint("/swagger/v1/swagger.json","swaggerTest");
;});

3.完整程式碼如下

using Microsoft.OpenApi.Models;
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();
builder.Services.AddSwaggerGen();
//註冊swagger服務
builder.Services.AddSwaggerGen(m =>
{
    //第一個引數"後端提供的版本號,自己定義"
    //Title: 專案的名字
    //Version: 當前專案的版本
    m.SwaggerDoc("v1", new OpenApiInfo { Title= "swaggerTest" , Version= "v1"});
});
var app = builder.Build();
// Configure the HTTP request pipeline.
if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI();
}
app.UseSwagger();
app.UseSwaggerUI(c =>
{
    //第一個引數:設定生成的json地址
    //v1 必須對應註冊swagger服務後端提供的版本號一致
    //第二個引數: 名稱
    c.SwaggerEndpoint("/swagger/v1/swagger.json","swaggerTest");
;});
app.UseAuthorization();
app.MapControllers();
app.Run();

配置啟動項預設開啟介面: 在 Properties 資料夾下開啟 launchSettings.json

相關文章