.NET Core中配置swagger

1 篇文章 0 订阅
1 篇文章 0 订阅
对于开发人员来说接口调试是必不可少的,对于swagger相比不会陌生接下来是在core中配置首先,先去NetGet包里去搜索Swashbuckle.AspNetCore然后点击下载

然后我们到Startup里来配置一下,在这里需要引用一下
using Microsoft.Extensions.DependencyInjection;然后我们找到ConfigureServices方法去进行配置以下代码
// 注册Swagger服务
services.AddSwaggerGen(c =>
{
    // 添加文档信息
    c.SwaggerDoc("v1", new Microsoft.OpenApi.Models.OpenApiInfo { 
        Title = "添加标题", Version = "v1" 
    });
    // 使用反射获取xml文件。并构造出文件的路径
    string xmlFile = @"你的存放路径";
    string xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
    // 启用xml注释. 该方法第二个参数启用控制器的注释,默认为false.
        c.IncludeXmlComments(xmlPath, true);
});
然后右键API项目->属性->生成 我们启用一下xml

然后我们再到Configure方法添加一下代码

//启用中间件服务对swagger-ui,指定Swagger JSON终结点
app.UseSwaggerUI(c =>
  {
    c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
  });
 需要注意的是我们要在Properties下的launchSettings.json文件里添加一下,项目运行就会自动帮我们启动swagger页面了,没加的话只能手动在地址栏输入路径了swagger/index.html

 

 

  • 1
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 1
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值