前言

ASP.NET Core Web API默認集成了Swashbuckle，可以在運行時顯示Swagger UI：

而Swagger UI實際上是解析的動態生成的swagger.json：

app.UseSwagger(); app.UseSwaggerUI(c?=>?c.SwaggerEndpoint("/swagger/v1/swagger.json",?"WebApplication3?v1"));

其實，部署ASP.NET Core Web API完成后，swagger.json的內容就不會改變了，完全可以用靜態文件替代。

實現

創建ASP.NET Core Web API項目，然后安裝Swashbuckle CLI：

dotnet?tool?install?SwashBuckle.AspNetCore.Cli

1.生成靜態文件

引用Nuget包Swashbuckle.AspNetCore.Annotations，并在項目下創建wwwroot\swagger\v1目錄，然后編寫生成后事件命令行：

dotnet?swagger?tofile?--output?./wwwroot/swagger/v1/swagger.json?$(OutputPath)$(AssemblyName).dll?v1

這樣，每次編譯項目，就會在目錄下生成swagger.json靜態文件。

2.使用靜態文件

修改Startup.cs：

//app.UseSwagger(); app.UseStaticFiles(); app.UseSwaggerUI(c?=>?c.SwaggerEndpoint("/swagger/v1/swagger.json",?"WebApplication3?v1"));

可以看到，我們注釋掉了app.UseSwagger()，這會移除SwaggerMiddleware，不會再在運行時生成swagger.json。

運行程序，訪問Swagger UI，和以前沒有任何區別。

結論

相對于運行時生成swagger.json，靜態文件性能更好，而且方便提供給第三方。

如果你覺得這篇文章對你有所啟發，請關注我的個人公眾號”My IO“

總結

以上是生活随笔為你收集整理的ASP.NET Core Web API使用静态swagger.json文件的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。