這篇文章將為大家詳細講解有關Asp.net core WebApi如何使用Swagger生成幫助頁，小編覺得挺實用的，因此分享給大家做個參考，希望大家閱讀完這篇文章后可以有所收獲。

我們注重客戶提出的每個要求，我們充分考慮每一個細節(jié)，我們積極的做好成都網(wǎng)站設計、做網(wǎng)站服務，我們努力開拓更好的視野，通過不懈的努力，成都創(chuàng)新互聯(lián)贏得了業(yè)內(nèi)的良好聲譽，這一切，也不斷的激勵著我們更好的服務客戶。 主要業(yè)務：網(wǎng)站建設,網(wǎng)站制作,網(wǎng)站設計,微信小程序開發(fā),網(wǎng)站開發(fā),技術開發(fā)實力，DIV+CSS，PHP及ASP，ASP.Net，SQL數(shù)據(jù)庫的技術開發(fā)工程師。

 一、引入swagger Nuget包

右鍵點擊wepapi項目的依賴項，點擊管理Nuget程序包，如下圖：

在打開的NuGet包程序管理界面，輸入：Swashbuckle.AspNetCore 目前該程序包的版本為1.0.0，點擊安裝。

安裝完后，需要在項目中的Startup.cs文件中進行配置。

二、配置Swagger

打開Startup.cs 文件，在ConfigureServices 方法中，添加如下代碼：

 services.AddSwaggerGen(c =>
      {
        c.SwaggerDoc("v1", new Info
        {
          Version = "v1",
          Title = "TwBusManagement接口文檔",
          Description = "RESTful API for TwBusManagement",
          TermsOfService = "None",
          Contact = new Contact { Name = "Alvin_Su", Email = "asdasdasd@outlook.com", Url = "" }
        });

        //Set the comments path for the swagger json and ui.
        var basePath = PlatformServices.Default.Application.ApplicationBasePath;
        var xmlPath = Path.Combine(basePath, "twbusapi.xml");
        c.IncludeXmlComments(xmlPath);

       // c.OperationFilter<HttpHeaderOperation>(); // 添加httpHeader參數(shù)
      });

注意上段代碼的最后三行，是我們api描述文檔xml的生成地址和文件名，需要在項目的屬性中進行配置。如下圖：

另外上圖中，禁止顯示警告中，添加1591 代碼，可以過濾掉一些類名沒有寫注釋的報警信息。

最后需要在Configure方法中，添加如下代碼，注意下面的代碼必須添加在  app.UseMvc() 前面：

 // Enable middleware to serve generated Swagger as a JSON endpoint.
      app.UseSwagger();

      // Enable middleware to serve swagger-ui (HTML, JS, CSS etc.), specifying the Swagger JSON endpoint.
      app.UseSwaggerUI(c =>
      {
        c.SwaggerEndpoint("/swagger/v1/swagger.json", "TwBusManagement API V1");
        c.ShowRequestHeaders();
      });

以上配置完后，就可以使用Swagger生成的幫助頁面了，運行項目后，在瀏覽器地址 加上后綴 /swagger就可以跳轉(zhuǎn)到幫助頁面：

當然我們開發(fā)人員在開發(fā)項目的過程中并不想每次都要手動輸入地址才能跳轉(zhuǎn)到幫助頁面，這樣太麻煩。我們可借助visual studio 進行跳轉(zhuǎn)，如下圖：

打開 launchSettings.json 文件，把webapi項目的啟動路徑設置成 swagger。這樣每次調(diào)試運行項目都會自動跳轉(zhuǎn)到swagger幫助頁面

三、Swagger的一些高級用法

Swagger非常強大，不僅僅是一些幫助頁面信息，還可以進行api的調(diào)試。這樣就可以不用借助第三方工具 如：postman，進行webapi的調(diào)試。swagger經(jīng)過配置，還可以輸入一些http頭部信息，如權限認證信息等。下面就來講解以下具體的配置。

首先我們需要新建一個類 HttpHeaderOperation，讓該類繼承IOperationFilter 接口，該接口需引入命名空間：Swashbuckle.AspNetCore.SwaggerGen，實現(xiàn)接口方法Apply 代碼如下：

 public class HttpHeaderOperation : IOperationFilter
  {
    public void Apply(Operation operation, OperationFilterContext context)
    {
      if (operation.Parameters == null)
      {
        operation.Parameters = new List<IParameter>();
      }

      var actionAttrs = context.ApiDescription.ActionAttributes();

      var isAuthorized= actionAttrs.Any(a => a.GetType() == typeof(AuthorizeAttribute));

      if (isAuthorized == false) //提供action都沒有權限特性標記，檢查控制器有沒有
      {
        var controllerAttrs= context.ApiDescription.ControllerAttributes();

        isAuthorized= controllerAttrs.Any(a => a.GetType() == typeof(AuthorizeAttribute));
      }

      var isAllowAnonymous = actionAttrs.Any(a => a.GetType() == typeof(AllowAnonymousAttribute));

      if (isAuthorized && isAllowAnonymous == false)
      {
        operation.Parameters.Add(new NonBodyParameter()
        {
          Name = "Authorization", //添加Authorization頭部參數(shù)
          In = "header",
          Type = "string",
          Required = false
        });
      }
    }
  }

然后在 Startup.cs 中的 ConfigureServices 方法，找到之前的AddSwaggerGen 代碼段，在最后添加如下代碼：

c.OperationFilter<HttpHeaderOperation>()

 services.AddSwaggerGen(c =>
      {
        c.SwaggerDoc("v1", new Info
        {
          Version = "v1",
          Title = "TwBusManagement接口文檔",
          Description = "RESTful API for TwBusManagement",
          TermsOfService = "None",
          Contact = new Contact { Name = "Alvin_Su", Email = "alvin_su@outlook.com", Url = "" }
        });

        //Set the comments path for the swagger json and ui.
        var basePath = PlatformServices.Default.Application.ApplicationBasePath;
        var xmlPath = Path.Combine(basePath, "twbusapi.xml");
        c.IncludeXmlComments(xmlPath);

        c.OperationFilter<HttpHeaderOperation>(); // 添加httpHeader參數(shù)
      });

這樣，我們允許webapi項目后，就可以輸入 Authorization 頭部參數(shù)了。如下圖：

關于“Asp.net core WebApi如何使用Swagger生成幫助頁”這篇文章就分享到這里了，希望以上內(nèi)容可以對大家有一定的幫助，使各位可以學到更多知識，如果覺得文章不錯，請把它分享出去讓更多的人看到。

名稱欄目：Asp.netcoreWebApi如何使用Swagger生成幫助頁-創(chuàng)新互聯(lián)
瀏覽路徑：http://www.chinadenli.net/article46/gsohg.html

成都網(wǎng)站建設公司_創(chuàng)新互聯(lián)，為您提供虛擬主機、靜態(tài)網(wǎng)站、網(wǎng)站內(nèi)鏈、用戶體驗、動態(tài)網(wǎng)站、外貿(mào)網(wǎng)站建設

廣告

聲明：本網(wǎng)站發(fā)布的內(nèi)容（圖片、視頻和文字）以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主，如果涉及侵權請盡快告知，我們將會在第一時間刪除。文章觀點不代表本網(wǎng)站立場，如需處理請聯(lián)系客服。電話：028-86922220；郵箱：631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載，或轉(zhuǎn)載時需注明來源： 創(chuàng)新互聯(lián)