ASP.NET Web API 使用Swagger 自动生成api文档

最新推荐文章于 2020-06-18 22:22:52 发布
最新推荐文章于 2020-06-18 22:22:52 发布
阅读量240 收藏
点赞数 1
分类专栏： .net web api C# 文章标签： asp.net web api web api c# .net
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq408146580/article/details/83340169
版权

撸项目的时候，每次接口写完，基本上写文档就成了最纠结的事情，虽然没什么难度。但是工作量还是挺费劲的。之前有了解过Swagger但是没有用过，正好这次研究下，与大家分享下。

1、先到NuGet安装Swagger

2、找到SwaggerConfig.cs。下面划红线的就是版本与名称

3、创建项目XML文档

4、修改SwaggerConfig.cs中的启动配置项

c.IncludeXmlComments(string.Format("{0}/bin/QY.WebApi.xml", System.AppDomain.CurrentDomain.BaseDirectory));

5、直接运行找到路径 http://localhost:52789/swagger/   就可以看到你的文档了。

邋遢的土豆
关注
  • 1
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
asp.net webapi集成swagger自动生成接口文档(亲测可用)
03-25
asp.net webapi集成swagger自动生成接口文档(亲测可用)swagger生成html离线接口文档swagger生成html离线接口文档
ASP.NET WebApi 使用Swagger生成接口文档
weixin_30952103的博客
05-03 164
前言 公司一直采用Word文档方式与客户端进行交流。随着时间的推移，接口变的越来越多，文档变得也很繁重。而且一份文档经常由多个开发人员维护，很难保证文档的完整性。而且有时写完代码也忘了去更新文档，为了这些小事经常受客户端同事鄙视。 于是带着问题去查找解决方案，在网上一通乱搜后查找出以下两个工具：AspNet.WebApi.HelpPage，Swagger。 细细比较最终选择Swa...
ASP.NET WEBAPI 使用Swagger生成API文档
weixin_33716941的博客
11-28 365
一、安装 新建一个没有身份验证的mvc项目 - SwaggerMvc5Demo，然后添加一个名为Remote（自定义）且包含基础读写（不想手写）的ApiController   开源地址：https://github.com/domaindrivendev/Swashbuckle 使用以下方法来添加 Swashbuckle： 从“程序包管理器控制台”窗口：Install-Pack...
swagger2 导出api为html和word文档
热门推荐
zhuyu19911016520
12-17 4万+
导出为html https://cloud.tencent.com/developer/article/1332445 导出为word https://www.cnblogs.com/jmcui/p/8298823.html https://github.com/JMCuixy/SwaggerToWord
ASP.NET WebAPI 使用Swagger在线接口文档
qq_35193189的博客
06-21 6811
关于 SwaggerSwagger能成为最受欢迎的REST APIs文档生成工具之一，有以下几个原因：Swagger 可以生成一个具有互动性的API控制台，开发者可以用来快速学习和尝试API。Swagger 可以生成客户端SDK代码用于各种不同的平台上的实现。Swagger 文件可以在许多不同的平台上从代码注释中自动生成。Swagger 有一个强大的社区，里面有许多强悍的贡献者。Swagger 文...
asp.net webapi 简单使用Swagger
gods_boy的博客
06-18 1214
什么是Swagger Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务,是一个在线的接口编辑文档，该文档描述了 API 的各种状态。 如何使用Swagger 新建Asp.net Webapi项目，使用nuget添加对Swagger的引用。 安装成功后可以看到在App_Start文件中创建了两个类：SwaggerNet和SwaggerConfig。 运行项目后会发现报错： 我们只需要在SwaggerNet类上面的两行代码注释掉即可运行成功。 [ass
Asp.net core WebApi 使用Swagger生成帮助页实例
10-19
本篇文章主要介绍了Asp.net core WebApi 使用Swagger生成帮助页实例，具有一定的参考价值，感兴趣的小伙伴们可以参考一下。
ASP.NET Core WebApi使用Swagger生成API说明文档
07-04
ASP.NET Core WebApi使用Swagger生成API说明文档 演示了如何在一个ASP.NET Core WebApi中使用SwaggerUI生成api说明文档。
Panda.DynamicWebApi:ASP.NET Core动态静态WebApi。 从类生成WebApi。 如
04-28
（1）创建一个新的ASP.NET Core WebApi（或MVC）项目 （2）安装包 Install-Package Panda.DynamicWebApi （3）创建一个名为AppleAppService的类，实现IDynamicWebApi接口，并添加属性[DynamicWebApi] [ ...
webapiclientgen：强类型客户端API生成器在ASP.NET Web API和.NET Core Web API中为jQuery和Angular 2+在C＃.NET和TypeScript中生成强类型客户端API。
02-01
强类型客户端API生成器以C＃代码和...主要特点生成的客户端API代码直接从Web API控制器方法，.NET基本类型和POCO类进行映射。 这类似于WCF中提供的svcutil.exe。 复制控制器方法和POCO类的文档注释。主要好处在RAD
在.Net Core WebAPI下给Swagger增加导出离线文档功能
韩俊俊的博客
01-09 3370
一丶前言   最近刚接触到Swagger，在github上下载了它的源码和demo学习了一遍，发现这个组件非常好用，不过不足的是它没有导出离线文档的功能，于是乎我就想给它加一个导出功能  Swagger Github开源地址 二丶思路 其实说白了api文档就是一个html静态页面，html可以转word或者pdf，那问题就变简单了。 1.想办法拿到swagger生成的api接口json数...
ASP.NET WebAPI 生成帮助文档与使用Swagger服务测试
weixin_33866037的博客
10-27 146
帮助HELP 要实现如WCF中的Help帮助文档，Web API 2 中已经支持很方便的实现了这一特性  http://www.asp.net/web-api/overview/creating-web-apis/creating-api-help-pages  Nuget获得 Install-Package Microsoft.AspNet.WebApi.HelpPage 安装完成后...
.net 将Swagger接口文档导出Word
qq_31975127的博客
10-11 3551
一.首先你的项目中要有Swagger这个接口请求文档，具体使用可参考我的博文中Swagger使用说明。 二.需要了解生成Swagger的UI页面是通过http://localhost:51974/swagger/docs/v1类似这样的请求接口返回的值填充的UI页面； 知道了是Swagger页面是通过调用接口来填充信息，那就好办了，我们可以直接取到这个接口的JSON数据，然后我们进行自己 需...
MethodInvoker 委托
qq408146580的专栏
12-23 3102
MethodInvoker 提供一个简单委托，该委托用于调用含 void 参数列表的方法。在对控件的 Invoke 方法进行调用时或需要一个简单委托又不想自己定义时可以使用该委托（摘自MSDN）   在多线程编程时，DotNet2.0会对跨线程访问控件进行限制的，说是为了线程安全。   MSDN提供一种声明委托的例子，使用MethodInvoker可以不用声明的 如： private
C#自定义配置文件
qq408146580的专栏
05-13 2149
.Net中的System.Configuration命名空间为我们在web.config或者app.config中自定义配置提供了完美的支持。 如果你已经对自定义配置了如指掌，请忽略这篇文章。 言归正传，我们先来看一个最简单的自定义配置 ? xml version="1.0" encoding="utf-8" ?> configura
c#委托与Lambda表达式
qq408146580的专栏
02-08 505
1、委托 委托非常好理解，类似于C++里面的函数指针（指向了一个方法），并且委托约束了待指向方法的签名(由返回类型和参数组成)。   using System; using System.Collections.Generic; using System.ComponentModel; using System.Data; using System.Drawing; using S
asp.net webapi如何自动生成接口文档
最新发布
04-15
Swagger是一个开源的API文档工具，它可以通过扫描应用程序的代码来自动生成API文档，并提供了一些交互式的UI组件供用户使用。您可以使用Swagger UI来浏览和测试API文档，使用Swagger Editor来编辑和测试Swagger规范...

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值