dotnet webapi 中添加Swagger文档

首先添加"SwaggerGenerator": "1.1.0","SwaggerUi": "1.1.0" 需要注意的是这两个组件是我对Swashbuckle的重新封装，因为当前版本对泛型会报错。

在ConfigureServices 中添加：

 services.ConfigureSwaggerGen(options =>

             {

                 options.SwaggerDoc("v1",

                   new Info

                   {

                       Version = "v1",

                       Title = "ryan API",

                   }

               );

                 options.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, Assembly.GetEntryAssembly().GetName().Name+".xml"));

                 options.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, Assembly.GetEntryAssembly().GetName().Name + ".Application.xml"));

                 options.DescribeAllEnumsAsStrings();

             });

在config方法中添加：

  if (HostingEnvironment.IsDevelopment())

             {

                 app.UseSwagger();

                 app.UseSwaggerUi(c=>c.SwaggerEndpoint("/swagger/v1/swagger.json", "V1 Docs"));

             }

在controller中需要添加attribute,否则文档会生成失败。

齐活，在浏览取中输入 http:{youhost}/swagger 即可访问了。

巴特西

dotnet webapi 中添加Swagger文档

最新文章

热门文章