Swagger

Swagger

下載套件:Swashbuckle.AspNetCore

(1)網站.csproj 的標籤結尾新增 a.標籤,值放 bin b.標籤,值放 true c.標籤,值放 $(OutputPath)$(AssemblyName).xml 可將XML說明轉成實體檔案,供Swagger套件讀取

(2)Program.cs 加入以下設定

//Swagger 產生器是負責取得 API 的規格並產生 SwaggerDocument 物件。 builder.Services.AddSwaggerGen();

//Swagger Middleware 負責路由,提供 SwaggerDocument 物件。 app.UseSwagger();

//將 SwaggerDocument 物件變成漂亮的介面。 app.UseSwaggerUI(swaggerService => { swaggerService.SwaggerEndpoint(‘/swagger/v1/swagger.json’, ‘My API V1’); });

微軟官方文件: https://learn.microsoft.com/zh-tw/aspnet/core/tutorials/getting-started-with-swashbuckle?view=aspnetcore-8.0&tabs=visual-studio

網路資源 https://ithelp.ithome.com.tw/articles/10195190 https://dotblogs.com.tw/yc421206/2022/03/12/via_swashbuckle_write_swagger_doc_in_asp_net_core_web_api

標籤: dotnet, api