1. 程式人生 > >.net core 學習日記二:添加swagger支持

.net core 學習日記二:添加swagger支持

star .json .net core 學習 web end direct dds ash

swagger 是restful api 文檔生成工具,當加入swagger後,發布api自動生成swagger 頁,記錄對應接口信息,並可在頁面直接測試調取接口。

這篇文章記錄一下在.net core webapi 項目如何引入 swagger

1.創建asp.net core api 程序 ,輸出類型選 控制臺應用程序(默認)

2.通過nuget引入swagger包,在程序包管理器控制臺輸入:install-package swashbuckle.aspnetcore 安裝。

技術分享圖片

3.右鍵項目選擇屬性進入設置頁,選擇生成頁,輸出項把 “XML文檔文件” 勾選上,保存

  技術分享圖片

4.對valuescontroller各個接口方法添加註釋

  技術分享圖片

5.打開startup.cs,加入swagger配置代碼

  在ConfigureServices方法中添加以下代碼  

  services.AddSwaggerGen(c =>
  {
    c.SwaggerDoc("v1", new Swashbuckle.AspNetCore.Swagger.Info
    {
      Title = "swagger xml api demo",

      Version = "v1",
    });

    var xmlPath=System.IO.Path.Combine(AppContext.BaseDirectory, "swagdemo.xml");
    c.IncludeXmlComments(xmlPath);
  });

  在Configure方法中添加一下代碼  

  app.UseSwagger();

  app.UseSwaggerUI(c =>

  {
    c.SwaggerEndpoint("/swagger/v1/swagger.json", "swagger cml api demo v1");
  });

  運行項目,轉到頁面http://localhost:55680/swagger(可到launchsettings.json文件調整端口和啟動頁),看具體效果

  技術分享圖片

  此外,還可以選擇具體方法調試

  技術分享圖片

  加入swagger,可以很直觀看api文檔,並進行調試。

  

.net core 學習日記二:添加swagger支持