WebApi生成文檔

本文包括兩個部分:web

  1. webapi中使用swagger
  2. 修改webapi的路由和默認參數
    • WebApi中使用swagger
    • 項目打開以後,選擇 引用,右鍵,管理NuGet程序包

    • 瀏覽,搜索swagger,選擇第一個swashbuckle,安裝

    • 安裝好以後,右鍵項目,選擇屬性,生成,在下面的輸出那裏勾選:XML文檔文件,若是沒有自動填充好路徑,須要本身填寫一下,文件名能夠本身

    • 打開App_Start文件夾下的SwaggerConfig.cs文件,新增一個以下方法:

    • private static string GetXmlCommentsPath()
      {
      return System.String.Format(@"{0}\bin\Coldairarrow.WebApi.xml", System.AppDomain.CurrentDomain.BaseDirectory);
      }api

    • 搜索GetXmlCommentsPath,下面能搜到已經註釋了,本身把註釋放開,要是沒搜到,就本身手動寫一下c.IncludeXmlComments(GetXmlCommentsPath());注意要寫在register方法裏面

    • 運行項目,在根路徑後面直接加swagger,就會自動跳轉到文檔,如:http://localhost:13520/swagger/ui/index,能看到咱們寫的一些註釋

相關文章
相關標籤/搜索