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

原创 已于 2023-03-23 16:11:18 修改 · 467 阅读 · 0 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#html #servlet #c#

于 2023-03-23 16:10:55 首次发布
在VisualStudio2022中，通过设置项目属性启用XML文档输出，然后在代码中使用SwaggerGen配置服务，结合控制器的注释，可以自动生成SwaggerUI以展示API文档。如果缺少XML文件，需要手动创建。

我用的是开发工具是 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显示状态

C#WebApi中swagger在线文档输出参数和输入参数显示注释
weixin_30247159的博客
05-21 3487
最近开发webapi 时需要生成在线文档，发现文档里面没注释，在网上查找资料都不齐全，或者看起来很难看懂。 花了点时间搞出来了这个，很多都是借鉴网上资料整理的，通俗易懂小白专用。 最终效果如上图所示 1.定义一个SwaggerControllerDescProvider实现ISwaggerProvider接口 using Swashbuckle.Swagger; us...
C# .net webapi使用swagger时显示controller注释
清雨小竹
04-27 3205
App_Start目录下新建SwaggerCacheProvider.cs using Swashbuckle.Swagger; using System; using System.Collections.Concurrent; using System.Collections.Generic; using System.IO; using System.Linq; using System.Web; using System.Xml; namespace YFAPICommon.App_Start
.net WebAPI Swagger 显示注释
最新发布
neveris2的博客
07-18 816
在使用VS开发WebAPI项目时，项目自动集成了Swagger。项目运行时即可显示Swagger页面，上面展示了开发好了所有服务接口，可以通过它测试接口服务和数据，非常方便开发者。其中对于接口的描述（注释）也必不可少。//注释文件名（路径）3、进入program.cs中按照一下代码替换“builder.Services.AddSwaggerGen();/// 通过cityId获取天气信息。
swagger @ApiModel 返回内容注释不显示问题
11-17
swagger @ApiModel 返回内容注释不显示问题 展开无类信息
怎么在Swagger调用WebApi时显示参数的注释
MonkeyBananas的博客
09-05 1万+
不说废话直接上解决方案。 一般都是使用Model类库，因为传参的话都是Model里来的，当然如果有定义比如：出入参的类库，下面我就按Model类库来说，其它类库也按以下步骤来就行了。 第一步：选中Model类型右键——属性——生成——XML文档文件打勾，后面会出来一个路径，你只需要复制一下最后的文件名就行了（包含后缀）。  第二步：在App_Start文件夹下面的SwaggerConfi...
.Net Core中使用Swagger,以及显示注释
zls365365的博客
03-25 4072
简介:相信无论是前端还是后端开发，都或多或少地被接口文档折磨过。前端经常抱怨后端给的接口文档与实际情况不一致。后端又觉得编写及维护接口文档会耗费不少精力，经常来不及更新。其实无论是前端调用后端，还是后端调用后端，都期望有一个好的接口文档。但是这个接口文档对于程序员来说，就跟注释一样，经常会抱怨别人写的代码没有写注释，然而自己写起代码起来，最讨厌的，也是写注释。所以仅仅只通...
c# webapi 配置swagger的方法
08-18
在C#开发的WebAPI项目中集成Swagger是一种十分常见的做法，Swagger作为一个开源的API开发工具，能够帮助开发者设计、构建、记录以及使用REST API。通过Swagger，开发者可以生成交互式的API文档，使API的测试和文档化...
django-rest-swagger对API接口注释的方法
09-18
在注释中，我们可以使用get和post等HTTP方法名来分别描述对应的操作。例如，get方法用来返回所有代码片段，而post方法用来创建新的代码片段实例。对于其他视图类`SnippetDetail`、`UserList`、`UserDetail`以及`...
MVC WebApi 文档生成注释说明的方法
beautifull001的博客
03-17 392
https://blog.youkuaiyun.com/phker/article/details/78110685
如何新建WebAPI，生成注释，TestAPI的项目
weixin_30920091的博客
07-05 240
一、新建WebAPI的项目 1. 在Web下，ASP.NET Web 应用程序，点击确定 2. 点击确定 3. 如图所示， 新建Controller 4 . 运行项目 二、注释 1.在生成中，勾选xml文档文件（生成注释文件） 2.修改HelpPageCofig，添加项目的APl.xml的配置 config....
.net 只需三步让Swagger显示注释
m0_47659279的博客
12-24 3588
.net 只需三步让Swagger显示注释 先看效果 第一步：导包(我使用的是.net5.0的框架，所以导入5.x的包，如果你使用.net6.0的框架，注意改版本号) Install-Package Swashbuckle.AspNetCore.Annotations -v 5.6.3 第二步：配置Swagger服务，调用EnableAnnotations()方法以启用注释 services.AddSwaggerGen(c => { c.EnableAnnotations(); }); 第三步
WebApi swagger 方法名及备注无法显示中文
qq_37523855的博客
06-17 1237
如下，swaggerpeich
C#在WEBAPI中配置Swagger
soulman1234的专栏
05-24 5207
在C#中，开发WEBAPI很多时候需要前后端联调，这其中就涉及到接口文档，而Swagger可以直接把接口文档在代码里生成出来，当然，你的代码的注释一定要写全。 首先创建一个WebAPi，此处就不多阐述了，基本操作： 然后在添加Nugget包： 在APP_START里找到SwaggerConfig， 在SwaggerConfig里增加配置：大概在108...
springboot WebAPi常用注解
weixin_45129218的博客
03-15 280
@RequestMapping /** * 顾名思义,请求映射,如果不指定具体的请求方法,则默认接收所有类型的请求 * @return */ @RequestMapping("getFilmInfoList") public List<FilmInfo> getFilmInfoList() { List<FilmInfo> list = iFilmInfoService.list(); return li
swagger注解
qq_39940489的博客
06-27 734
swagger常用注解
.Net Core Swagger注释显示不全，我来帮你解决
The Shio的博客
08-28 3694
前戏我就不做了，我喜欢直接点 我们知道swagger的注释依赖于xml，但有时候在发布后没xml，这不是难为我吗？我还得给前端一个字段一个字段解释,查资料后，找到解决方案 1.可能你查询的实体或者返回的实体不在webapi那个库，因此你需要你涉及到的实体库都开启生成xml文档 2.在你需要开启生成xml文件的类库的.csproj中加 GenerateDocumentationFile <PropertyGroup> <TargetFramework>netcoreapp3
C# 注释换行
weixin_30722589的博客
05-19 225
在写程序的时候,有时需要对注释进行换行.如下: class Program { static void Main(string[] args) { Msg(); } /// <summary> /// 这是第一行 /// 这是第二行 ///...
.NET Core WebAPI中使用Swagger（完整教程）
热门推荐
西瓜程序猿
08-02 1万+
Swagger是一个规范且完整的框架，用于生成、描述、调试和可视化Restfull风格的Web服务。Swagger的目标是对Rest API定义一个标准且和语言无关的接口，可以让人和计算机拥有无需访问源码、文档或网络流量监控就可以发现和连接服务的能力。当通过Swagger进行正确定义，用于可以理解远程服务并使用最少逻辑与远程服务进行交互。与为底层编程所实现的接口类似，Swagger消除了调用服务时可能会有的猜测。
NET Swagger显示控制器注释
oXingYunWangZi1的博客
12-27 778
1.设置项目生成xml：项目 / 右键 / 属性 / 生成 / 勾选复选框[XML文档文件] 2.添加Nuget：Swash public class SwaggerConfig { public static void Register() { var thisAssembly = typeof(SwaggerConfig).Assembly; GlobalConfiguration.Configuratio.
ASP.NET WebAPI集成Swagger UI教程与文档
在ASP.NET WebAPI中集成Swagger UI是为了提供一个可视化的界面，帮助开发者和API使用者了解API的结构和功能。Swagger是一种流行的API文档生成工具，它可以自动生成文档，并提供一个交互式的API控制台，允许测试API...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值