.NetCore中使用Swagger文檔自動生成

 

1、創建一個.NetCore WebApi項目

 

2、使用Nuget安裝Swagger，安裝的命令是:

Install-Package Swashbuckle.AspNetCore -Pre

 

3、安裝完Swagger插件之後，在Startup.cs文件中的ConfigureServices方法和Configure方法註冊並使用Swagger服務。

在ConfigureServices方法中添加如下代碼：

public void ConfigureServices(IServiceCollection services)
        {
            //註冊Swagger
            services.AddSwaggerGen(c =>
            {
                //V1：後端版本
                c.SwaggerDoc("v1", new OpenApiInfo
                {
                    Title = "Gs.Swagger", //項目名稱 
                    Version = "v1"  //版本 和後端版本沒有關係
                });
            });

            services.AddControllers();
        }

 

在Configure方法中添加如下代碼：

//註冊好之後，接下來引用Swagger服務
app.UseSwagger();
app.UseSwaggerUI(c => //UI界面
{
    //參數1：寫上動態生成的json信息；其中的版本和上面SwaggerDoc中的版本一致
    //參數2：文檔名稱
    c.SwaggerEndpoint("/swagger/v1/swagger.json", "Gs.Swagger");
});

4、到目前爲止，項目中已經安裝好了Swagger，最後更改Properties下的launchSettings.json，設置Swagger文檔爲起始頁

5、運行項目，就可以看到項目的接口文檔了

 

文中項目GitHub地址：https://github.com/wangongshen/GsSwagger