webapi中swagger的方法中显示注释内容

已于 2023-03-23 16:11:18 修改
阅读量319 收藏
点赞数
分类专栏： # swagger 文章标签： html servlet c#
于 2023-03-23 16:10:55 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/easyboot/article/details/129733043
版权

我用的是开发工具是 visual studio 2022

选择项目的属性

 选择build->Output->documentation file 勾选上

在program.cs中增加swagger配置(如果程序运行中没有找到xml文件需要手动创建一个空的xml文件)

 builder.Services.AddSwaggerGen(option =>
{
    var xmlFilename = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
    option.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, xmlFilename), true);
});

在controller中写注释

 swagger显示状态

easyboot
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
swagger注解
qq_39940489的博客
06-27 574
swagger常用注解
c# webapi 配置swagger的方法
01-19
在使用项目中，我们希望去查看我们的webapi的测试，那么我们是需要去有一个集成的测试的。 步骤 1.在nutget管理包中下载swagger包。 2.这样会在App_start 文件夹中出现swaggerconfig.cs 和swaggerNet.cs, 这个时候就...
怎么在Swagger调用WebApi时显示参数的注释
MonkeyBananas的博客
09-05 9788
不说废话直接上解决方案。 一般都是使用Model类库，因为传参的话都是Model里来的，当然如果有定义比如：出入参的类库，下面我就按Model类库来说，其它类库也按以下步骤来就行了。 第一步：选中Model类型右键——属性——生成——XML文档文件打勾，后面会出来一个路径，你只需要复制一下最后的文件名就行了（包含后缀）。  第二步：在App_Start文件夹下面的SwaggerConfi...
.Net Core WebApi 发布程序后在Swagger的API说明文档中不显示中文注释的解决办法
最新发布
Session_W的博客
04-17 247
Swagger的API说明文档中不显示中文注释的解决办法
.net 只需三步让Swagger显示注释
m0_47659279的博客
12-24 3035
.net 只需三步让Swagger显示注释 先看效果 第一步：导包(我使用的是.net5.0的框架，所以导入5.x的包，如果你使用.net6.0的框架，注意改版本号) Install-Package Swashbuckle.AspNetCore.Annotations -v 5.6.3 第二步：配置Swagger服务，调用EnableAnnotations()方法以启用注释 services.AddSwaggerGen(c => { c.EnableAnnotations(); }); 第三步
springboot WebAPi常用注解
weixin_45129218的博客
03-15 222
@RequestMapping /** * 顾名思义,请求映射,如果不指定具体的请求方法,则默认接收所有类型的请求 * @return */ @RequestMapping("getFilmInfoList") public List<FilmInfo> getFilmInfoList() { List<FilmInfo> list = iFilmInfoService.list(); return li
NET Swagger显示控制器注释
oXingYunWangZi1的博客
12-27 615
1.设置项目生成xml：项目 / 右键 / 属性 / 生成 / 勾选复选框[XML文档文件] 2.添加Nuget：Swash public class SwaggerConfig { public static void Register() { var thisAssembly = typeof(SwaggerConfig).Assembly; GlobalConfiguration.Configuratio.
.Net Core2.1 WebAPI新增Swagger插件详解
10-18
主要给大家介绍了关于.Net Core2.1 WebAPI新增Swagger插件的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
WebApi-SwaggerUI.rar
08-23
Swagger 是一款RESTFUL接口的、基于YAML、JSON语言的文档在线自动生成、代码自动生成的工具。WebAPI使用Swagger就能够很方便简洁的把所写的接口以及相关注释展示出来
django-rest-swagger对API接口注释的方法
01-20
总体目标是使客户端和文件系统服务器以同样的速度来更新，方法，参数和模型紧密集成到服务器端的代码中，允许API始终保持同步。 在使用 django-rest-framework 进行API开发，可以使用django-rest-swagger接入swagger...
HerokuContainer：Heroku中的Dockerized ASP.NET Core 3 Web API应用程序
02-06
Heroku中的Dockerized ASP.NET Core 3 Web API应用程序 在此博客文章中，我们将创建一个容器化的ASP.NET Core 3.1 Web API项目，并使用Gi​​tHub Actions建立CI / CD管道。 在GitHub工作流程中，我们将构建和测试...
Swagger文档显示中文注释
qq_46368587的博客
01-20 2480
1，点击项目【属性】——>【生成】勾选XML文档文件，选择输出路径 取消显示警告添加【;1591】，否则会有警告，不添加也可 2.修改startup 添加代码，其xmlpath的参数"APIDemo.xml" 为上图所选择的xml文档文件。 var basePath = Path.GetDirectoryName(typeof(Program).Assembly.Location); //获取应用程序所在目录（绝对，不受工作目录影响，建议采用此方法获取路径） var xmlPath = P.
Swagger显示注释
小卡拉米的博客
07-01 1889
1.点击项目，右键=》生成=》勾选XML文档文件=》添加1591取消警告 2.完成之后会生成对应的XML文件 3.在Startup.cs 方法ConfigureServices中修改AddSwaggerGen内容 public void ConfigureServices(IServiceCollection services) { services.AddControllers(); services.A...
.Net Core中使用Swagger,以及显示注释
zls365365的博客
03-25 3810
简介:相信无论是前端还是后端开发，都或多或少地被接口文档折磨过。前端经常抱怨后端给的接口文档与实际情况不一致。后端又觉得编写及维护接口文档会耗费不少精力，经常来不及更新。其实无论是前端调用后端，还是后端调用后端，都期望有一个好的接口文档。但是这个接口文档对于程序员来说，就跟注释一样，经常会抱怨别人写的代码没有写注释，然而自己写起代码起来，最讨厌的，也是写注释。所以仅仅只通...
.net 6 web api给Swagger添加api注释
weixin_44442366的博客
03-14 637
默认情况下我们api是没有注释的在api方法上面添加xml注释在Program.cs文件配置Swagger,添加以下代码AssemblyGetNameName。
swagger显示默认注释内容
Sun的专栏
12-30 1217
services.AddSwaggerGen(c => { c.SwaggerDoc("v1", new OpenApiInfo { Title = "HF WebAPI", Version = "v1" }); //添加读取注释服务 nuget Microsoft.Extensions.PlatformAbstractions var base...
Swagger中显示注释
weixin_30886233的博客
07-05 949
Webapi中Swagger中不显示注解的解决方法 1、找见生成项目时候生成的xml文件。查看存放路劲方法： 右键项目-->点击属性-->在属性中选择“生成”就能看见xml文件存放路径； 2、在项目启动程序中将生成的xml文件注入。 启动程序 注解出现 转载于:https://www.cnblogs.com/dhcnblog/p/9269958.html...
在Web API项目中，用Swagger编程语句描述接口的例子？
05-16
以下是一个使用Swagger描述接口的例子： ```csharp /// <summary> /// 获取用户信息 /// </summary> /// <param name="id">用户ID</param> /// <returns>用户信息</returns> [HttpGet("{id}")] [ProducesResponseType(typeof(UserInfo), StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound)] public IActionResult GetUser(int id) { var user = _userService.GetUser(id); if (user == null) { return NotFound(); } return Ok(user); } ``` 上面的代码描述了一个获取用户信息的接口。使用`HttpGet`特性指定了HTTP请求方法为GET，使用`ProducesResponseType`特性指定了接口返回的数据类型和HTTP响应码。使用XML注释描述了接口的功能，参数和返回值。Swagger会根据这些信息生成API文档和测试工具。

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值