Swagge如何在ASP.NetCore項目中使用

Swagge如何在ASP.NetCore項目中使用？相信很多沒有經驗的人對此束手無策，為此本文總結了問題出現的原因和解決方法，通過這篇文章希望你能解決這個問題。

什么是swagger

使人和計算機在看不到源碼或者看不到文檔或者不能通過網絡流量檢測的情況下能發現和理解各種服務的功能。

Swagger? 的目標是為 REST APIs 定義一個標準的，與語言無關的接口。只需要按照它的規范去定義接口及接口相關的信息。再通過Swagger衍生出來的一系列項目和工具，就可以做到生成各種格式的接口文檔，生成多種語言的客戶端和服務端的代碼，以及在線接口調試頁面等。

所帶來的幫助

當項目處于啟動階段
如果有了穩定的后臺框架，直接依據業務需求編寫服務端被調用層的代碼（即controller及其入參出參對象），然后通過Swagger生成相關描述文件，使用者就可以直接使用了。
如果后臺框架不成熟或在設計中，但是依據業務需求我們可以完成更多的工作而不是等待，先根據數據需求編寫Swagger描述文件，通過該描述文件生成接口文檔，指引項目的相關開發。
當項目處于迭代階段
在項目的持續開發中，后端人員無需關注Swagger描述文件和接口文檔，有需求變更導致接口變化，可直接編程實現，然后生成新的描述文件和接口文檔后，給到前端即可。

使用Swagger

首先，先創建一個新的WebAPI項目，并在Nuget中找到對應的包，搜索Swashbuckle會出現很多應用包，可以根據描述選擇自己需要的引用。我在這里使用的是Swashbuckle.AspNetCore.Filters

接下來在Startup中插入如下代碼
注冊服務

services.AddSwaggerGen(options =>
      {
        options.SwaggerDoc("v1", new OpenApiInfo
        {
          Title = "HTTP API 目錄",
          Version = "v1",
          Description = "目錄微服務HTTP API。"
        });
      });

中間件

 //啟用中間件服務生成Swagger作為JSON終結點
      app.UseSwagger();
      //啟用中間件服務對swagger-ui，指定Swagger JSON終結點
      app.UseSwagger().UseSwaggerUI(c =>
      {
        c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
      });

然后，就可以使用了，請求對應地址 https://localhost:44375/swagger/index.html，現在就可以看到示例代碼中的WeatherForecast.cs了。

看完上述內容，你們掌握Swagge如何在ASP.NetCore項目中使用的方法了嗎？如果還想學到更多技能或想了解更多相關內容，歡迎關注億速云行業資訊頻道，感謝各位的閱讀！