asp.net webapi 简单使用Swagger

最新推荐文章于 2024-05-13 22:57:59 发布
最新推荐文章于 2024-05-13 22:57:59 发布
阅读量1.2k 收藏 2
点赞数 1
分类专栏： asp.net webapi swagger asp.net 文章标签： asp.net webapi swagger
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/gods_boy/article/details/106844006
版权
这篇博客介绍了如何在ASP.NET WebAPI项目中使用Swagger，包括Swagger的定义、安装步骤、解决运行错误的方法，以及如何添加接口描述信息，帮助开发者生成和可视化RESTful API。
摘要由CSDN通过智能技术生成

什么是Swagger

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务,是一个在线的接口编辑文档，该文档描述了 API 的各种状态。

如何使用Swagger

新建Asp.net Webapi项目，使用nuget添加对Swagger的引用。
在这里插入图片描述
安装成功后可以看到在App_Start文件中创建了两个类：SwaggerNet和SwaggerConfig。
运行项目后会发现报错：在这里插入图片描述
我们只需要在SwaggerNet类上面的两行代码注释掉即可运行成功。

[assembly: WebActivator.PreApplicationStartMethod(typeof(Swagger.App_Start.SwaggerNet), "PreStart")]
[assembly: WebActivator.PostApplicationStartMethod(typeof(Swagger.App_Start.SwaggerNet), "PostStart")]

再次运行项目，在地址栏后面输入Swagger即可
在这里插入图片描述

<
最低0.47元/天 解锁文章
做一只有理想的猫
关注
  • 1
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Asp.Net Core WebAPI使用Swagger时API隐藏和分组详解
10-17
主要给大家介绍了关于Asp.Net Core WebAPI使用Swagger时API隐藏和分组的相关资料，文中通过示例代码介绍的非常详细，对大家学习或者使用Asp.Net Core具有一定的参考学习价值，需要的朋友们下面来一起学习学习吧
ASP.NET WEB API 配置 Swagger
Spo的博客
07-27 829
设置swagger显示的版本号和标题、设置接口描述xml路径地址、加载汉化的js文件。在项目中找到App_Start文件夹配置SwaggerConfig.cs。在App_Start文件夹配置增加SwaggerControllerDescProvider.cs类。注意添加js时，文件属性必须设置为"嵌入的资源"。在Scripts文件夹增加SwaggerConfig.js。NuGet包管理器->搜索Swashbuckle。...
ASP.NET Web API 使用Swagger
HPFBoy的博客
12-09 468
1.swagger 引用 第一步： 第二步：修改SwaggerConfig.cs 1.设置版本号，以及Swagger的Title 2.配置启用，记录一些webapi 的基本配置东西 第三步：创建项目XML注释文档 右键项目→属性→生成→选中下方的 "XML文档文件" 然后保存 第四步：配置路由 App_Start/WebApiConfig.cs。根据IP地址默认会打开Swagger config.Routes.MapHttpRou...
ASP.NET Web Api 如何使用 Swagger 管理 API
最新发布
yangshuquan的专栏
05-13 967
Swagger 是一个强大的工具，可以帮助开发人员设计、构建和文档化 RESTful API，提高 API 的可读性、可维护性和互操作性，有了它，我们就可以更方便、更有效率地管理 API。 在 ASP.NET Core 中，已经内置了 Swagger，很方便就能使用。但在 ASP.NET 里，需要我们自己引用和配置才能使用它，下面通过一个 Step By Step 例子来看看 ASP.NET Web Api 如何使用 Swagger。
ASP.NET WebAPI 使用Swagger在线接口文档
qq_35193189的博客
06-21 6843
关于 SwaggerSwagger能成为最受欢迎的REST APIs文档生成工具之一，有以下几个原因：Swagger 可以生成一个具有互动性的API控制台，开发者可以用来快速学习和尝试API。Swagger 可以生成客户端SDK代码用于各种不同的平台上的实现。Swagger 文件可以在许多不同的平台上从代码注释中自动生成。Swagger 有一个强大的社区，里面有许多强悍的贡献者。Swagger 文...
ASP.NET WEBAPI swagger使用
huazaizuiaiw的专栏
09-01 290
参考博客：完整教程说明 https://www.cnblogs.com/yanweidie/p/5709113.html 解决类库引用问题（请求是个实体不显示说明） https://www.cnblogs.com/eastday/p/6382613.html 加载多个xml说明文件 ...
asp.net webapi集成swagger自动生成接口文档(亲测可用)
03-25
asp.net webapi集成swagger自动生成接口文档(亲测可用)swagger生成html离线接口文档swagger生成html离线接口文档
Asp.Net WebApi添加SwaggerUI
01-08
Asp.Net WebApi添加SwaggerUI是一项重要的开发任务，它能够为API提供友好的文档和测试接口，便于开发者理解和使用API。SwaggerUI是Swagger工具集的一部分，它基于Swagger规范，能够生成交互式的API文档，使API的调试...
Asp.net core WebApi 使用Swagger生成帮助页实例
10-19
本篇文章主要介绍了Asp.net core WebApi 使用Swagger生成帮助页实例，具有一定的参考价值，感兴趣的小伙伴们可以参考一下。
Asp.Net Mvc WebApi集成Swagger
芝麻麻雀-Asp.Net学习之路
10-24 1374
看到好多都用Swagger生成API文档，但是在网上找了几个blog根据写了之后，发现一下坑，现记录下来 1、新建一个项目，SwaggerMvc5Demo，如果选择mvc项目，需要引用web API引用。或者直接选择Web API项目。 2、添加对Swagger的引用：在nuget中搜索：Swashbuckle，现在的版本为5.6.0；进行安装 3、点击项目-&gt;属性-&gt;生成，在输...
【.Net】ASP.NET项目使用Swagger生成API文档
liuzhenhe1988的专栏
08-05 1213
目前.net core项目自带swagger可以说是好用到爆，不仅可以清晰看到所有api接口，最主要的是可以直接进行调试，是不是很爽；但是对于.net framework项目目前没有自动继承swagger，可能调试起来还得借助其他工具，那么接下来就和大家一起将swagger集成到.net framework...
ASP.NET WebApi使用Swagger做接口文档
weixin_30539835的博客
09-10 211
一，什么是Swagger 相信在做接口的,都会被接口文档烦的不行，接口文档没及时更新，前后端不一致等问题，而Swagger就是用来解决这一问题的！Swagger会根据api方法的注释生成相应的文档，让开发人员不必须再去写接口文档！效果图如下 二，如何在ASP.NET WebApi中使用Swagger 首先，创建一个WebApi程序SwaggerDemo,这里我不再说如何...
ASP.NET WebApi 文档Swagger中度优化
weixin_33713350的博客
11-25 117
本文版权归博客园和作者吴双本人共同所有，转载和爬虫请注明原文地址： www.cnblogs.com/tdws   写在前面 在后台接口开发中，接口文档是必不可少的。在复杂的业务当中和多人对接的情况下，简单的接口文档又不能满足需求，试想你的单应用后台有几十个模块，几百甚至更多的接口，又有上百个ViewModel。怎么能让人用起来更顺手更明了？本篇介绍第一步的中度优化，下一篇将分享下一阶段的深度优...
.Net WebApi接口Swagger集成简单使用
weixin_34253126的博客
05-06 692
Swagger介绍 Swagger 是一款RESTFUL接口的、基于YAML、JSON语言的文档在线自动生成、代码自动生成的工具。而我最近做的项目用的是WebAPI,前后端完全分离，这时后端使用Swagger就能够很方便简洁的把所写的接口以及相关注释展示给前端人员， 从而方便双方的沟通，提高工作效率。 官网地址：https://swagger.io/ 开始使用Swagger 1.首...
asp.net core学习——core webapi中配置并使用swagger
小徐的博客
08-05 909
一、什么是swagger swagger是一个用于生成、描述和调用RESTful接口的Web服务。通俗来讲就是将项目中所有(想要暴露的接口)接口展现在页面上，并可以进行接口调用和测试的服务。 二、安装swagger 首先我们创建一个.net core webapi的项目 然后进入工具–NuGet包管理器–程序包管理器控制台 中输入 PM> Install-Package Swashbuckle.AspNetCore -Version 5.0.0-rc4 安装swagger 三、swagger的
asp.net webApi集成swagger
qq_41863998的博客
08-20 867
打开nuget管理器，搜索：swagger 1.安装：Swashbuckle 2.安装：Swagger-Net 3.安装：Swagger.Net.UI 4.打开SwaggerNet.cs文件，把截图中的代码注释掉，不然会报错，报错信息：程序集“Swagger.Net, Version=0.5.1.0, Culture=neutral, PublicKeyToken=null”中的类型“Swagger.Net.XmlCommentDocumentationProvider”的方法“GetDocumen
[Asp.Net Core]ASP.NET Core WebApi使用Swagger生成api说明文档看这篇就够了
德仔
01-16 946
引言 在使用asp.net core 进行api开发完成后，书写api说明文档对于程序员来说想必是件很痛苦的事情吧，但文档又必须写，而且文档的格式如果没有具体要求的话，最终完成的文档则完全取决于开发者的心情。或者详细点，或者简单点。那么有没有一种快速有效的方法来构建api说明文档呢？答案是肯定的， Swagger就是最受欢迎的REST APIs文档生成工具之一！ 为什么使用Swagger作为REST APIs文档生成工具 Swagger 可以生成一个具有互动性的API控制台，开发者可以用来快速学习和尝试A
建立项目接口文档_在ASP.NET Core API项目中集成Swagger和带搜索的Redoc接口文档
weixin_28707535的博客
01-12 492
介绍swagger使我们在api开发中常用到的技术，其解决了web api文档生成的问题。它具有诸多交互式文档、客户端SDK生成和api可发现性等优点。由于笔者是从事.net core方向的开发，所以咱们就聊一聊在.net core web api的项目中集成swagger或者redoc。NSwag.NET本文主要讲的是使用NSwag.NET来将swagger集成到项目中来，包括swagger和r...
在iis上部署你的asp.net core web api项目及swagger
08-26
在IIS上部署ASP.NET Core Web API项目及Swagger可以按照以下步骤进行： 1. 首先，我们需要确保已经在本地系统上安装了ASP.NET Core Runtime和ASP.NET Core Hosting Bundle，以便在IIS中运行ASP.NET Core应用程序。 ...

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值