dotnet webapi 中添加Swagger文档

博客介绍了对Swashbuckle重新封装的两个组件SwaggerGenerator和SwaggerUi的添加,版本为1.1.0,因当前版本对泛型会报错。还说明了在ConfigureServices、config方法及controller中的配置要点,添加相应内容,最后在浏览器输入特定地址即可访问文档。

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

    在ConfigureServices 中添加:

   

 1 services.ConfigureSwaggerGen(options =>
 2             {
 3                
 4                 options.SwaggerDoc("v1",
 5                   new Info
 6                   {
 7                       Version = "v1",
 8                       Title = "ryan API",
 9                   }
10               );
11                 options.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, Assembly.GetEntryAssembly().GetName().Name+".xml"));
12                 options.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, Assembly.GetEntryAssembly().GetName().Name + ".Application.xml"));
13                 options.DescribeAllEnumsAsStrings();
14             });

在config方法中添加:

1  if (HostingEnvironment.IsDevelopment())
2             {
3                 app.UseSwagger();
4                 app.UseSwaggerUi(c=>c.SwaggerEndpoint("/swagger/v1/swagger.json", "V1 Docs"));
5             }

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

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

转载于:https://www.cnblogs.com/ryansecreat/p/6094643.html

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值