C#添加WebApi，配置Swagger

最新推荐文章于 2024-08-05 16:35:39 发布
最新推荐文章于 2024-08-05 16:35:39 发布
阅读量1.1k 收藏
点赞数
分类专栏： C# 文章标签： webapi swagger
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/wangxiaojia42121/article/details/132617353
版权
本文档介绍了如何在C# WebApi项目中添加和配置Swagger。首先，通过Nuget包管理器安装Swashbuckle.AspNetCore包。接着，在Startup.cs文件的ConfigureServices和Configure方法中配置Swagger中间件。确保WebApi、Swagger配置及swagger/index.html的正确性。最后，设置启动时直接跳转到Swagger界面，并启用XML注释以显示详细的API文档。
摘要由CSDN通过智能技术生成

1、创建一个WebAPI项目


下载、安装、引入【Swashbuckle.AspNetCore】包

右击【解决方案】，然后点击【管理Nuget包】，搜索【Swashbuckle.AspNetCore】包

2、配置Swagger中间件

在【Startup.cs】文件中的【ConfigureService】类中添加如下代码。

在【Startup.cs】文件中的【Configure】类中启用Swagger中间件

3、运行项目

WebApi配置正确

Swagger配置正确

最低0.47元/天 解锁文章
小P孩42121
关注
专栏目录
net学习：C#在WEBAPI配置Swagger
weixin_41812784的博客
08-01 593
在前后端分开开发中，WEBAPI很多时候需要前后端联调，这其中就涉及到接口文档，代码的注释写全就可以用Swagger直接把接口文档在代码里生成出来。 一、建立WEBAPI项目： 二、nuget搜索Swashbuckle添加，如图：项目中会出现SwaggerConfig配置文件，如图： 三、配置XML文件，如图： 接口中一般会用到Model层定义实体，所以也需要配置Model的XML，方法同上...
C#Swagger的创建和使用
qq_37580539的博客
12-31 1万+
C# 中 swaggerSwagger的介绍在C#如何安装Swagger Swagger的介绍 Swagger 是一个规范且完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。 Swagger 的目标是对 REST API 定义一个标准且和语言无关的接口，可以让人和计算机拥有无须访问源码、文档或网络流量监测就可以发现和理解服务的能力。当通过 Swagger 进行正确定义，用户可以理解远程服务并使用最少实现逻辑与远程服务进行交互。与为底层编程所实现的接口类似，Swagger 消除了
C# Web Api项目集成Swagger
最新发布
donot_look_back的博客
08-05 412
创建C# API项目，集成Swagger，添加接口参数注释
c# webapi 配置swagger的方法
08-18
主要介绍了c# webapi 配置swagger的方法，文中示例代码非常详细，帮助大家更好的理解和学习，感兴趣的朋友可以了解下
C# （WebApi）整合 Swagger
可达鸭的博客
02-23 2622
C# webapi 也可以整合Swaggerwebapi运行其实有个自带的HELP页面但是如果觉得UI不好看，且没办法显示方法注释等不方便的操作，我们也可以整合Swagger。
.Net WebAPI 增加Swagger
weixin_34342578的博客
12-25 166
第一部分：创建项目 选择Web/ASP.NET Web Application 这里我选择的是WebAPI，并且增加MVC和Web API，权限部分选择无权限 第二部分：增加EF连接 因为项目需要连接至SQL Server，在Web API项目中增加EF是比较好的选择。 因为数据已经是存在的，所以选择DB first 创建新的数据库连接 选择...
c#配置swagger文档
qq_53217825的博客
05-16 5908
虽然现在已经有.net8.0了，但是.net6因为已经出来两年了，所以更多公司在用，而且6.0和8.0的差别并不是很大，还是有一些可学的地方的，目前.net core 6.0的资料是最多的，所以搭建项目建议使用6.0会比较好。和上一个基本一致，注释都在代码中有写，在项目属性中开启“生成包含api文档的文件”，开启方法》右键项目》属性》生成》输出》打开“生成包含api的文档的文件”我们的项目地址应该在这里设置，其中以什么方式运行，这个就是基础了，试一下就知道了，勾选openapi支持。
C# .net webapi使用swagger时显示controller注释
清雨小竹
04-27 2934
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
C# .net core WebApi Swagger配置
qq_45308912的博客
01-15 721
1.首先进行项目的创建，我这边以.net 7 为例来进行解说，因为.net 7中没有startup.cs文件，startup.cs文件已与program.cs文件进行了合并，我们来配置program.cs文件来让Swagger文档支持控制器的注释以及操作方法的注释。配置完成后，右键项目文件夹=》属性，勾选生成包含API文档的文件，勾选完毕后重新生成解决方案，即可在项目的DeBug目录下 可以查看到 ReadingPlatForm.xml这个配置文件。（这个文件的名称 最好以项目名称进行命名）
c# webAPI项目 添加 Swagger 调试
t13701275189的博客
12-09 1015
c# webAPI项目 添加 Swagger 调试
webapi添加swagger页面
qq_38313984的博客
10-27 578
5分钟了解swagger
热门推荐
菜刚RyuGou的专栏
08-27 35万+
随着互联网技术的发展，现在的网站架构基本都由原来的后端渲染，变成了：前端渲染、先后端分离的形态，而且前端技术和后端技术在各自的道路上越走越远。 前端和后端的唯一联系，变成了API接口；API文档变成了前后端开发人员联系的纽带，变得越来越重要，swagger就是一款让你更好的书写API文档的框架。其他API文档工具没有API文档工具之前，大家都是手写API文档的，在什么地方书写的都有，有在confl
C# 在webapi项目中配置Swagger
Hakim2214的博客
12-02 910
首先，创建webpapi类型的项目 TestSwagger 安装swagger+swagger ui包 打开nuget界面，搜索swagger，并安装下面两个 安装完成之后，可以看到这些类与文件都是安装完成时swagger添加的 打开xml文档文件 右键项目属性—>生成—>勾选XML文档文件 4、SwaggerNet类中，注释类上面的两行，就会运行成功 这时，运行成功 添加注释 我们发现，安装完成后，写注释并没有在swagger页面上面增加，所以我们现在开开启注释 在.
C#在WEBAPI中配置Swagger
soulman1234的专栏
05-24 5013
在C#中，开发WEBAPI很多时候需要前后端联调，这其中就涉及到接口文档，而Swagger可以直接把接口文档在代码里生成出来，当然，你的代码的注释一定要写全。 首先创建一个WebAPi，此处就不多阐述了，基本操作： 然后在添加Nugget包： 在APP_START里找到SwaggerConfig， 在SwaggerConfig里增加配置：大概在108...
C# webapi 配置 swagger
杭电鬼先生交流中心
07-11 843
1.vs->工具->NuGet包管理器->管理解决方案的NuGet程序包 2.程序包源选择nuget.org,然后搜索 swagger (丝袜哥儿...)哈哈，我喜欢这样读。 3.选择你要安装的项目 4.安装好了之后，在App_start 文件夹下的SwaggerConfig.cs中写入方法，然后在Register()方法调用 private stati...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值