ASP.NET CORE 邊學邊記之 SwaggerUI簡單配置

丶Pz發表於2018-05-25
ASP.NETSwaggerUI

前言

　　當使用 ASP.NET CORE 開發WebApi程式時候，一般使用SwaggerUI生成介面文件。本文記錄最簡單的一個配置。（生成的文件無註釋）

操作

　　首先安裝Nuget包。

　　

　　然後在Startup中配置Swagger。

 //新增swagger
            services.AddSwaggerGen(s =>
            {
                s.SwaggerDoc("v1", new Info
                {
                    Version = "v1",
                    Title = "介面標題",
                    Description = "介面描述",
                    Contact = new Contact { Name = "聯絡人", Url = "Url" },
                });
            });

　　最後，使用Swagger。

 public void Configure(IApplicationBuilder app, IHostingEnvironment env)
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }

            app.UseMvc();

            app.UseSwagger();
            app.UseSwaggerUI(s =>
            {
                s.SwaggerEndpoint("/swagger/v1/swagger.json", "Univ NoticeService API v1.0");
            });
        }

　　在啟動程式之前可以修改 Propertities資料夾下launchSettings.json.將  launchUrl 改為 swagger。然後啟動網站，效果如下：

 

總結

　　由於是公司內部使用，所以並沒有太深入研究，比如引入註釋的xml檔案等。不過這點東西已經夠入門的啦~~

 

相關文章