Asp.Net Core WebApi搭建Swagger — 接口文档自动生成器

1.通过NuGet引入 Swashbuckle.AspNetCore

在这里插入图片描述

2.将自定义服务通过依赖注入的方式添加到 IServiceCollection 容器中

其中 WeatherForecastTest 是Controller控制器
SwaggerDoc中的第一个参数 name,此处的值参考控制器接口名上方添加

[ApiExplorerSettings(GroupName = “WeatherForecast”)]

[ApiExplorerSettings(GroupName = “Test”)]
在这里插入图片描述

2.容器中的服务,最终在 Configure 方法中进行使用

在这里插入图片描述

3.运行程序,在域名后面输入/swagger

通过下图可以清楚看到之前代码中各个属性在页面中是如何展示的
在这里插入图片描述

4.让某个接口不在swagger文档中出现

在接口名上方添加

[HttpGet]
[ApiExplorerSettings(IgnoreApi = true)] //让此接口不在swagger文档中出现
public ActionResult<string> Cs2()
  {
     return  "Cs2";
  }
5.出现下面报错

在这里插入图片描述

我的问题是没有指定接口的请求方式,缺少[HttpGet]或[HttpPost]等

[HttpGet] //指定接口的请求方式
[ApiExplorerSettings(IgnoreApi = true)] //让此接口不在swagger文档中出现
public ActionResult<string> Cs2()
    {
       return  "Cs2";
    }
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

DotNeter-Hpf

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值