1. 程式人生 > 實用技巧 >.Net Core WebApi 之 Swagger 註釋

.Net Core WebApi 之 Swagger 註釋

問題:

  上一篇文章我們已經可以通過Swagger生成的Web頁面對WebApi進行測試。先希望WebApi的具體方法有對應的註釋。

解決:

1:在StartUp.cs 中新增以下程式碼:

  public void ConfigureServices(IServiceCollection services)
        { 
            services.AddControllers();

            // 註冊Swagger服務
            services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
            services.AddSwaggerGen(c 
=> { c.SwaggerDoc("v1", new OpenApiInfo { Title = "My Demo API", Version = "v1.0", Description = "My Demo API" } ); c.SwaggerDoc("v2", new OpenApiInfo { Version
= "v1.0", Title = "基礎介面", Description = "使用者登入認證介面" }); // 為 Swagger 設定xml文件註釋路徑 var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml"; var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
// 新增控制器層註釋,true表示顯示控制器註釋 c.IncludeXmlComments(xmlPath, true); }); }
View Code

2:設定專案屬性--生成 頁面:如下圖

3:新增WebApi具體方法的註釋(略)

4:執行程式,顯示如下: