安裝NuGet 程式包=》Swashbuckle.AspNetCore 在 Startup.ConfigureServices 方法里添加註冊生成器 1 //註冊Swagger生成器,定義一個和多個Swagger 文檔 2 services.AddSwaggerGen(c => 3 { 4 c.Sw ...
安裝NuGet 程式包=》Swashbuckle.AspNetCore
在 Startup.ConfigureServices 方法里添加註冊生成器
1 //註冊Swagger生成器,定義一個和多個Swagger 文檔 2 services.AddSwaggerGen(c => 3 { 4 c.SwaggerDoc("v1", new Info() { Title = "測試版本", Version = "v1" }); 5 6 c.ResolveConflictingActions(apiDescriptions => apiDescriptions.First()); 7 c.CustomSchemaIds(type => type.FullName); // 解決相同類名會報錯的問題 8 9 c.IncludeXmlComments(Path.Combine(Directory.GetCurrentDirectory(), "SwaggerDemo.xml")); // 註釋要使用的 XML 文檔 10 });
如果需要使用到在頁面顯示控制器的一些註釋,可選擇生成-輸出-XML文檔文件。
1591可免去一些沒有加註釋的一些警告。
註釋實例:
----
在 Startup.Configure 方法里添加中間件服務
//啟用中間件服務生成Swagger作為JSON終結點 app.UseSwagger(); //啟用中間件服務對swagger-ui,指定Swagger JSON終結點 app.UseSwaggerUI(c => { c.SwaggerEndpoint("/swagger/v1/swagger.json", "DemoAPI V1"); });
添加完後,可以自己建控制器了。
註意:控制器必須是API標識的控制器。
裡面的方法也必須帶有HTTP請求協議。
最後執行訪問=》/swagger/index.html
學習來自依樂祝大佬的文章=》點擊進入超時空傳送