iT邦幫忙

2025 iThome 鐵人賽

DAY 17
0
自我挑戰組

打造自己的Medium系列 第 17

Day17 Swagger

  • 分享至 

  • xImage
  •  

ASP.NET Core有兩個Swagger生成工具可以用

  1. Swashbuckle 因為不支援新版本的.NET我就直接跳過,有興趣可以參考這篇
  2. NSwag

Nswag

  1. NSwag安裝指令dotnet add package NSwag.AspNetCore
    官方給的指令有包含依賴檔的名稱
    dotnet add NSwagSample.csproj package NSwag.AspNetCore
    可以自己修改想要的依賴檔,或是就不加

  2. 然後Program.cs加入這幾行

builder.Services.AddControllers();
// 這行可以去設定Swagger文件資料
builder.Services.AddOpenApiDocument(options =>
{
    options.PostProcess = document =>
    {
        document.Info = new NSwag.OpenApiInfo
        {
            Version = "v1",
            Title = "Leni API",
            Description = "An ASP.NET Core Web API for article platform"

        };
    };
});
// Configure the HTTP request pipeline.
if (app.Environment.IsDevelopment())
{
    // Add OpenAPI 3.0 document serving middleware
    // Available at: http://localhost:<port>/swagger/v1/swagger.json
    app.UseOpenApi();


    // Add web UIs to interact with the document
    // Available at: http://localhost:<port>/swagger
    app.UseSwaggerUi(); // UseSwaggerUI Protected by if (env.IsDevelopment())

}
  1. 執行dotnet run
    就可以跟著網址看到到swagger了
    swagger ui

參考資料

  1. Get started with NSwag and ASP.NET Core

作者的哈拉

今天有點忙碌,差點就停更了,最近都只能稍微前進一點點


上一篇
Day16 多型
下一篇
Day18 Entity Framework Core
系列文
打造自己的Medium30
圖片
  熱門推薦
圖片
{{ item.channelVendor }} | {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

尚未有邦友留言

立即登入留言