一、引言
本篇文章是Swagger的詳細使用，續(xù)上篇ASP.NET Core Web API入門之一：創(chuàng)建新項目。
Swagger 是一個規(guī)范和完整的框架，用于生成、描述、調(diào)用和可視化 RESTful 風格的 Web 服務的接口文檔。
二、Swagger的作用以及優(yōu)點
2.1 作用
根據(jù)在代碼中使用自定義的注解來生成接口文檔，這個在前后端分離的項目中很重要。這樣做的好處是 在開發(fā)接口時可以通過swagger 將接口文檔定義好，同時也方便以后的維護。
2.2 優(yōu)點
號稱是最流行的 API 框架
接口文檔在線生成，避免同步的麻煩
可以支持在線對接口執(zhí)行測試
支持多語言
三、API接口添加注釋
3.1 編輯項目文件
項目(右鍵)->編輯項目文件->添加鍵
<GenerateDocumentationFile>True</GenerateDocumentationFile>
3.2 修改 Startup.cs 文件的 ConfigureServices 方法
找到 services.AddSwaggerGen();，直接替換為下面代碼，接下來運行工程看效果。
services.AddSwaggerGen(options =>
{
options.SwaggerDoc("v1", new Microsoft.OpenApi.Models.OpenApiInfo
{
Version = "v1", //版本
Title = "WDQ API", //標題
Description = "吳東強的API" //描述
});
//添加API接口注釋
var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
options.IncludeXmlComments(xmlPath);
});
3.3 修改瀏覽器的網(wǎng)頁標題
在 Configure 方法中找到app.UseSwaggerUI()，使用箭頭函數(shù)修改 DocumentTitle 屬性，代碼如下
app.UseSwaggerUI(options =>
{
options.DocumentTitle = "WDQ API"; //瀏覽器的網(wǎng)頁標題
});
3.4 注冊路由中間件
重點：在Configure方法中注冊路由中間件，目的是要讓控制器中的路由能夠被請求，否則將404。
app.UseRouting();//使用路由
app.UseAuthorization();//使用授權，明確你是否有某個權限。
//使用匹配的端點
app.UseEndpoints(endponits =>
{
endponits.MapControllers(); //將本程序集定義的所有Controller和Action轉(zhuǎn)換為一個個的EndPoint，放到路由中間件的配置對象RouteOptions中
});
3.4 接口添加注釋
注意：這樣添加注釋會導致整個項目的cs文件都會有提示缺少XML注釋。文章來源：http://www.zghlxwxcb.cn/news/detail-554080.html
四、運行后效果
結(jié)語：Swagger是不錯的框架，有興趣的可以繼續(xù)深入學習下。文章來源地址http://www.zghlxwxcb.cn/news/detail-554080.html
到了這里，關于ASP.NET Core Web API入門之二：Swagger詳細使用&路由設置的文章就介紹完了。如果您還想了解更多內(nèi)容，請在右上角搜索TOY模板網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關文章，希望大家以后多多支持TOY模板網(wǎng)！
