快捷導(dǎo)航

Asp.net core WebApi 使用Swagger生成幫助頁(yè)實(shí)例

更新時(shí)間：2017年04月25日 10:22:11 作者：suxin

本篇文章主要介紹了Asp.net core WebApi 使用Swagger生成幫助頁(yè)實(shí)例，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下。

最近我們團(tuán)隊(duì)一直進(jìn)行.net core的轉(zhuǎn)型，web開(kāi)發(fā)向著前后端分離的技術(shù)架構(gòu)演進(jìn)，我們后臺(tái)主要是采用了asp.net core webapi來(lái)進(jìn)行開(kāi)發(fā)，開(kāi)始每次調(diào)試以及與前端人員的溝通上都存在這效率低下的問(wèn)題，一次在看微軟asp.net core官方文檔的時(shí)候，發(fā)現(xiàn)了swagger這個(gè)好東西。然后在實(shí)際的項(xiàng)目中引入了該技術(shù)。我們開(kāi)發(fā)人員測(cè)試自己寫(xiě)的api的過(guò)程大大得到了簡(jiǎn)化，前端人員也可以根據(jù)我們提供的swagger help pages 自己進(jìn)行一些前端代碼的測(cè)試，大大提高了前后端的開(kāi)發(fā)效率。下面我就拿我自己的真實(shí)上線項(xiàng)目來(lái)一步一步的講解如何在asp.net core webapi中引入swagger。(也可以參照微軟官方文檔：https://docs.microsoft.com/zh-cn/aspnet/core/tutorials/web-api-help-pages-using-swagger)

一、引入swagger Nuget包

右鍵點(diǎn)擊wepapi項(xiàng)目的依賴(lài)項(xiàng)，點(diǎn)擊管理Nuget程序包，如下圖：

在打開(kāi)的NuGet包程序管理界面，輸入：Swashbuckle.AspNetCore 目前該程序包的版本為1.0.0，點(diǎn)擊安裝。

安裝完后，需要在項(xiàng)目中的Startup.cs文件中進(jìn)行配置。

二、配置Swagger

打開(kāi)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的生成地址和文件名，需要在項(xiàng)目的屬性中進(jìn)行配置。如下圖：

另外上圖中，禁止顯示警告中，添加1591 代碼，可以過(guò)濾掉一些類(lèi)名沒(méi)有寫(xiě)注釋的報(bào)警信息。

最后需要在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生成的幫助頁(yè)面了，運(yùn)行項(xiàng)目后，在瀏覽器地址加上后綴 /swagger就可以跳轉(zhuǎn)到幫助頁(yè)面：

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

打開(kāi) launchSettings.json 文件，把webapi項(xiàng)目的啟動(dòng)路徑設(shè)置成 swagger。這樣每次調(diào)試運(yùn)行項(xiàng)目都會(huì)自動(dòng)跳轉(zhuǎn)到swagger幫助頁(yè)面

三、Swagger的一些高級(jí)用法

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

首先我們需要新建一個(gè)類(lèi) HttpHeaderOperation，讓該類(lèi)繼承IOperationFilter 接口，該接口需引入命名空間：Swashbuckle.AspNetCore.SwaggerGen，實(shí)現(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都沒(méi)有權(quán)限特性標(biāo)記，檢查控制器有沒(méi)有
      {
        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ù)
      });

這樣，我們?cè)试Swebapi項(xiàng)目后，就可以輸入 Authorization 頭部參數(shù)了。如下圖：