VS 启用 ASP.NET Core 3.1 Web API 应用中的 Swagger 文档

最新推荐文章于 2024-03-02 15:18:20 发布
最新推荐文章于 2024-03-02 15:18:20 发布
阅读量564 收藏 1
点赞数
分类专栏： dotnet core
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/u010833391/article/details/105678162
版权

1.添加Swashbuckle.AspNetCore
在这里插入图片描述
2.添加swagger 依赖注入到Startup类,
2.1 services.AddSwaggerGen(s=> { s.SwaggerDoc(“v1”, new OpenApiInfo { Title = “My API”, Version = “v1” }); });
在这里插入图片描述
2.2 app.UseSwagger();
app.UseSwaggerUI(c=> {
c.SwaggerEndpoint("/swagger/v1/swagger.json", “My API V1”);
});
在这里插入图片描述
3.重新编译 项目 后run起项目
在这里插入图片描述
4.页面测试访问
https://localhost:5001/swagger/index.html
在这里插入图片描述

瞬间即为永恒
关注
专栏目录
记录一次ASP.NET 3.1 Webapi中使用JWT认证过程
APPLEHU09的博客
07-05 1363
框架：asp.net 3.1IDE：VS2019一、创建一个.NET CORE 3.1的webapi项目，这里创建过程就不赘述了，使用VS2019一步步创建即可；二、创建完后需要NuGet Package手动添加Microsoft.AspNetCore.Authentication.JwtBearer库。三、为方便接口测试，我们先加入swagger接口帮助文档（1）手动添加Swashbuckle.AspNetCore.SwaggerGen；Swashbuckle.AspNetCore.SwaggerUI；U
Asp.Net core下Swagger适配二级目录及Nginx SSL证书配置
ldy的专栏
09-13 1155
文章目录一、背景二、环境三、实现1.Nginx配置2.Swagger相关代码和配置调整2.1 Swagger相关代码和配置调整总结 一、背景   当前，前后端分离以及微服务化已经是趋势。因此，后端通常会有多个webapi应用。为访问多个应用，可以采用多个域名/IP或者单个域名/IP加不同端口的方式。但通常域名或者IP有限，而不同端口要采用非80/443等默认端口，也会导致不便。因此，单域名/IP+默认端口+二级目录就成为一种比较友好和方便的方式。 二、环境 asp.net core 3.1 （3.1.8
在Visual Studio 2017中创建 Web API并整合Swagger
05-29
Swagger是一种与技术无关的标准，允许发现REST API，为任何软件提供了一种识别REST API功能的方法。 这比看起来更重要：这是一个改变游戏技术的方式，就像Web服务描述语言一样WSDL（Web Service Description Language）一样。 WSDL一直是使Visual Studio等工具和IDE 可以理解Web服务并创建代理类的基础技术。此功能将Web服务的消耗转换为高级任务，封装所有协议详细信息。 这是Swagger的重要性：它可以为REST API做出WSDL已经为Web服务所做的工作，允许创建代理和使用Web API更容易。 VS 2017包括使用Swagger协议支持REST API代理创建。它还处于早期阶段，缺乏一些特点，但这是向广泛采用Swagger迈出的重要一步。 我们将创建一个例子，说明我们如何使用Swagger与VS 2017来分析优势和缺少的功能。 以及VS 2017，我们还将需要安装在开发机器中的IIS（Internet Information Server）作为示例。
ASP.NET Core 3.1使用Swagger
qq_33678106的博客
09-03 475
一、什么是Swagger 随着技术的不断方法，现在的网站开发基本都是使用前后端分离的模式，这样使前端开发者和后端开发者只需要专注自己擅长的即可。但这种方式会存在一种问题：前后端通过API接口的方式进行调用，接口文档的好坏可以决定开发的进度。以前如果使用Word的形式提供接口文档，或多或少的都会存在各种问题。前端抱怨说后端给的接口文档与实际情况不一致。而后端开发人员又觉得编写以及维护接口文档很费精力，文档经常不能及时更新，导致前端看到的还是旧的接口文档。这时候就需要使用Swagger了。 那么什么是...
ASP.NET Core 3.1系列（12）——使用Swagger构建Web API文档
HerryDong的博客
04-25 788
1、前言 在前后端分离的开发模式下，相信无论是前端还是后端开发，都或多或少地被接口文档折磨过。前端经常抱怨后端给的接口文档与实际情况不一致，后端又觉得编写及维护接口文档会耗费不少精力，经常来不及更新。因此，随着时间推移和版本迭代，接口文档往往很容易就跟不上代码了。这时候我们就需要使用Swagger来帮助我们自动构建API文档。Swagger是一个规范和完整的框架，用于生成、描述、调用和可视化RESTful风格的Web服务。下面开始介绍如何在ASP.NET Core中使用它。 2、配置Swagger 2.1、
使用 ASP.NET Core 创建 Web API（基于Net.Core 3.1和Visual Studio 2019）
MELF晓宇的博客
10-13 1836
使用 ASP.NET Core 创建 Web API 创建Web项目 打开Visual Studio 2019，点击创建新项目 选择ASP.NET Core Web API 输入项目名称，勾选将解决方案和项目房租同一目录中 选择目标框架为.NET Core 3.1，勾选配置HTTPS 生成的项目目录结构如下图所示 运行项目会在浏览器中跳转出如下内容 添加模型类 在项目根目录下新建Models文件夹 点击右键，选择添加，选择类。 将类命名为TodoItem 新建的TodoItem类如图所示
使用 ASP.NET Core 构建 Web API
介绍ASP.NET Core和Web API 1.1 什么是ASP.NET Core ASP.NET Core是由微软开发的开源Web框架，用于构建现代、高性能的Web应用程序。它跨平台运行，支持Windows、Linux和macOS系统。 1.2 什么是Web API Web API是...
（四）如何在.NET Core 3.x 中使用Swagger
ananlele_的专栏
07-21 572
在服务端开发过程中，特别是在前后端分离的项目中，后端人员往往会提供出来很多API接口供前端人员使用。一般后端人员会在开发接口的过程中同时维护一份文档（如word、excel），用来说明每一个接口的访问方式、需要的参数、返回的结果等基本信息。但是这种传统的API书写方式很费时间，而且容易造成因为接口文档更新不及时导致的前后端交流成本增加的问题。 基于上述情况，诞生了许多API接口文档自动化生成工具，如Swagger、I/O Docs、apiary.io、Docco、Dexy、Doxygen、TurnAPI。
ASP.NET Core 5.0 Web API的构建与使用
ASP.NET Core 5.0 Web API简介 ## 1.1 ASP.NET Core 5.0概述 ASP.NET Core 5.0是Microsoft推出的全新跨平台开源框架，用于构建现代化的云端互联网应用程序。它具有高性能、跨平台、模块化设计等特点，是.NET技术...
vs2019 .net core3.0 Swagger
最新发布
qq_61596453的博客
03-02 1236
vs219 .net core 创建 swagger
Visual Studio 2017 and Swagger: Building and Documenting Web APIs
doi2746的博客
06-26 434
Swagger是一种与技术无关的标准，允许发现REST API，为任何软件提供了一种识别REST API功能的方法。 这比看起来更重要：这是一个改变游戏技术的方式，就像Web服务描述语言一样WSDL（Web Service Description Language）一样。 WSDL一直是使Visual Studio等工具和IDE可以理解Web服务并创建代理类的基础技术。此功能将We...
【VS2017】WebApi集成Swagger
听一首歌♫
05-05 751
小编的经历 最近在做项目的时候，需要用到WebApi，于是自己开始进行这方面的学习，在此之前，可以说是对WebApi只限于知道的层面，根本就不了解，更不要说自己去创建一个WebApi的项目了，所以在一番努力之下，终于实现了WebApi项目的创建以及Swagger的集成，下面和大家介绍一下！ 准备工作 首先，我们要创建一个WebApi的项目，比较简便的方法就是先创建一个空白解决方案，然后在空白解决方...
.NetCore WebApi 3.1 Swagger建立流程
weixin_42046939的博客
01-15 661
第一步 第二步 第三步 第四步 第五步 第六步 安装成功后可以在依赖库中知找到： 第七步 第八步 “launchUrl”: “swagger/index.html”, 第九步 在代码里加上注释 结果： ...
一、使用Swagger（接口文档工具）
HiDaJing
03-15 2111
前言：本次学习都是在VS2022上进行，其它VS版本实现可能存在差异，仅自己学习记录。 一、创建项目，本章主要讲的是接口文档在线生成工具Swagger,需要创建WebAPI项目,点击下一步 二、输入项目名称和选择项目存储位置，点击下一步 三、取消勾选“配置HTTPS“项，勾选"启用OpenAPI支持"项，点击创建 ......
vs2022 搭建NET6 WebApi 接口项目《二》 配置swagger
wh55llme的博客
02-02 1981
vs2022 搭建NET6 WebApi 接口项目《二》 配置swagger
Visual studio code整合Swagger-ui简易方法
Cqing
12-06 9269
1、首先我们需要安装swagger-ui依赖包 在终端控制台输入命令:dotnet add YourProjectName.csproj package Swashbuckle.AspNetCore 2、添加配置和Swagger中间件 在Startup.cs文件的ConfigureServices方法内添加代码如下: // Register the Swagger generator, def...
swagger在VS2019 .net core2.2中的使用，及报错undefined /swagger/v1/swagger.json的解决办法
热门推荐
欲掩不从心
10-11 2万+
swagger在 .net core中的使用：点击前往 在安装大佬的步骤来配置swagger后来配置，发现一些问题。特此总结下 安装包：Swashbuckle.AspNetCore 在Startup.cs 配置swagger 在ConfigureServices中添加代码 //注册Swagger生成器，定义一个和多个Swagger 文档 services.AddSwaggerGen(c ...
.Net WebApi接口调试之Swagger集成详解
qq_31766265的博客
07-19 1万+
引：以前没有写博的习惯，后来 在网上看到有些问题被一些刚入行的同学问来问去没有完整的教程供他们参考，决定以后也把自己的一些经验分享到网上，希望能帮助其他同学的同时，更多的与大家交流！有不对的地方还请多多指点，互相学习，共同进步。 本文详细的介绍了.net从一个新的项目中创建api后集成swagger调试接口的流程！ 1、首先我们创建一个MVC项目（VS2012）： 2、然后在项目中的
.net core3.1 webapi 项目框架
07-13
### 回答1： .NET Core 3.1 Web API 项目框架是一个用于构建基于RESTful风格的Web API的开发框架。它是.NET Core平台的一部分，可以运行在多个操作系统上，如Windows、Linux和MacOS。以下是该框架的一些主要特点： 1. 跨平台：.NET Core 3.1 Web API可以在多个操作系统上运行，这为开发人员带来了更大的灵活性和便利性。 2. 高性能：.NET Core是一个高性能的框架，可以处理大量的并发请求。它经过优化，能够提供快速响应时间和较低的资源消耗。 3. 轻量级：相比于传统的.NET框架，.NET Core是一个更轻量级的框架。它采用了模块化体系结构，可以选择性地引用和使用需要的组件，减少了部署包的大小。 4. 开放性：.NET Core 3.1 Web API是一个开放的框架，可以与其他平台和技术进行无缝集成。它支持多种数据格式和协议，如JSON、XML、RESTful和WebSocket等。 5. 高度可扩展：通过使用中间件和自定义管道，开发人员可以方便地扩展和定制Web API的功能。它还支持依赖注入和插件机制，使得代码的组织和测试变得更加简单。 6. 安全性：.NET Core 3.1 Web API提供了强大的安全性功能，包括身份验证、授权、访问控制等。它支持常见的认证方案，如基于令牌的身份验证和OAuth。 总之，.NET Core 3.1 Web API是一个现代化、高效且可扩展的框架，适用于构建各种规模的Web API应用程序。它简化了开发过程，提供了丰富的功能和工具，帮助开发人员快速构建高质量的API。 ### 回答2： .NET Core 3.1 Web API项目框架是用于构建基于RESTful风格的Web服务的开发框架。它是在跨平台、高性能和可扩展性方面进行了优化的框架。 .NET Core 3.1是一个开源的、跨平台的框架，可以在Windows、Linux和Mac等多个操作系统上运行。这意味着我们可以使用相同的代码和工具来构建应用程序，无需为不同的操作系统创建额外的代码。 Web API是一种使用HTTP协议提供数据交互的应用程序编程接口。它通过HTTP请求（通常是GET、POST、PUT、DELETE）来处理数据，并返回JSON或XML等数据格式作为响应。Web API是一种通用的服务架构，可以与不同平台上的客户端应用程序进行通信。 在.NET Core 3.1 Web API项目框架中，我们可以使用C#来编写API控制器，通过定义不同的API端点和路由来处理不同类型的请求。我们可以使用一些常用的属性（如[HttpGet]、[HttpPost]等）来定义API端点，并使用参数绑定来获取请求中的数据。 框架还提供了丰富的中间件和插件，以处理身份验证、授权、日志记录等常见的开发需求。我们还可以通过使用依赖注入来管理应用程序中的组件和服务。 另外，.NET Core 3.1框架还提供了一些实用的工具和库，例如Entity Framework Core、Swagger等，可以简化数据库访问和API文档生成等任务。 总之，.NET Core 3.1 Web API项目框架是一个强大、灵活和高效的开发框架，可以帮助我们构建出高性能和可靠的Web服务。它具有跨平台的优势，并提供了丰富的功能和工具来简化开发流程。 ### 回答3： .NET Core 3.1是一个跨平台的开发框架，适用于构建不同类型应用的云和互联网解决方案。在.NET Core 3.1中，WebAPI项目框架也得到了重要的改进和功能增强。 首先，.NET Core 3.1的WebAPI项目框架提供了更强大的路由功能，可以使用属性路由来定义API的访问路径，从而更灵活地组织和管理API的接入点。 其次，.NET Core 3.1的WebAPI项目框架引入了端点路由的概念，可以根据不同的HTTP方法和路由规则来映射到不同的动作方法，从而实现更细粒度的控制。 此外，.NET Core 3.1的WebAPI项目框架还提供了更强大的模型绑定功能，可以将请求的数据自动绑定到动作方法的参数上，大大减少了编写冗余代码的工作量。 在数据序列化方面，.NET Core 3.1的WebAPI项目框架支持多种数据格式，包括JSON和XML，可以根据客户端的需求选择合适的数据格式进行传输。 此外，.NET Core 3.1的WebAPI项目框架还提供了强大的中间件支持，可以实现各种功能，如身份验证、授权、异常处理等，极大地提高了开发效率。 总体来说，.NET Core 3.1的WebAPI项目框架在路由、模型绑定、数据序列化和中间件方面都得到了重要的改进和增强，为开发者提供了更强大、更灵活的开发工具，使得构建高性能、可扩展的WebAPI应用变得更加简单和方便。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值