您的位置：首页 > 编程技术 > csharp  >  ASP.NetCore使用Swagger实战

ASP.NetCore使用Swagger实战

 更新时间：2020年11月11日 10:59  点击：1954

踩坑不背锅，.NET Core 试深浅 关于Swagger什么是swagger所带来的帮助 使用Swagger

关于Swagger

什么是swagger

使人和计算机在看不到源码或者看不到文档或者不能通过网络流量检测的情况下能发现和理解各种服务的功能。

在这里插入图片描述

Swagger™ 的目标是为 REST APIs 定义一个标准的，与语言无关的接口。只需要按照它的规范去定义接口及接口相关的信息。再通过Swagger衍生出来的一系列项目和工具，就可以做到生成各种格式的接口文档，生成多种语言的客户端和服务端的代码，以及在线接口调试页面等。

所带来的帮助

当项目处于启动阶段
如果有了稳定的后台框架，直接依据业务需求编写服务端被调用层的代码（即controller及其入参出参对象），然后通过Swagger生成相关描述文件，使用者就可以直接使用了。
如果后台框架不成熟或在设计中，但是依据业务需求我们可以完成更多的工作而不是等待，先根据数据需求编写Swagger描述文件，通过该描述文件生成接口文档，指引项目的相关开发。
当项目处于迭代阶段
在项目的持续开发中，后端人员无需关注Swagger描述文件和接口文档，有需求变更导致接口变化，可直接编程实现，然后生成新的描述文件和接口文档后，给到前端即可。

使用Swagger

首先，先创建一个新的WebAPI项目，并在Nuget中找到对应的包，搜索Swashbuckle会出现很多应用包，可以根据描述选择自己需要的引用。我在这里使用的是Swashbuckle.AspNetCore.Filters

在这里插入图片描述

接下来在Startup中插入如下代码
注册服务

services.AddSwaggerGen(options =>
      {
        options.SwaggerDoc("v1", new OpenApiInfo
        {
          Title = "HTTP API 目录",
          Version = "v1",
          Description = "目录微服务HTTP API。"
        });
      });

中间件

 //启用中间件服务生成Swagger作为JSON终结点
      app.UseSwagger();
      //启用中间件服务对swagger-ui，指定Swagger JSON终结点
      app.UseSwagger().UseSwaggerUI(c =>
      {
        c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
      });

然后，就可以使用了，请求对应地址 https://localhost:44375/swagger/index.html，现在就可以看到示例代码中的WeatherForecast.cs了。

在这里插入图片描述

到此这篇关于ASP.NetCore使用Swagger实战的文章就介绍到这了,更多相关ASP.NetCore使用Swagger内容请搜索猪先飞以前的文章或继续浏览下面的相关文章希望大家以后多多支持猪先飞！

[!--infotagslink--]

相关文章

  • Swagger中@ApiIgnore注解的使用详解

    这篇文章主要介绍了Swagger中@ApiIgnore注解的使用，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教...2021-10-21

  • c# webapi 配置swagger的方法

    这篇文章主要介绍了c# webapi 配置swagger的方法，文中示例代码非常详细，帮助大家更好的理解和学习，感兴趣的朋友可以了解下...2020-07-09

  • Swagger2匹配多个controller代码实例

    这篇文章主要介绍了Swagger2匹配多个controller代码实例,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下...2020-09-19

  • 关于springboot整合swagger问题及解决方法

    这篇文章主要介绍了关于springboot整合swagger问题及解决方法,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下...2021-04-20

  • Asp.Net Core中发送Email的完整步骤

    这篇文章主要给大家介绍了关于Asp.Net Core中发送Email的完整步骤，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧...2021-09-22

  • Spring集成Swagger常见错误及解决办法

    这篇文章主要介绍了Spring集成Swagger常见错误及解决办法，帮助大家更好的理解和学习使用Spring，感兴趣的朋友可以了解下...2021-05-03

  • Asp.Net Core实现Excel导出功能的实现方法

    这篇文章主要给大家介绍了关于Asp.Net Core实现Excel导出功能的实现方法，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧...2021-09-22

  • 手把手教你SpringBoot快速集成Swagger的配置过程

    这篇文章主要介绍了手把手教你SpringBoot快速集成Swagger的配置过程,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下...2021-02-21

  • 基于swagger测试List类型参数过程详解

    这篇文章主要介绍了基于swagger测试List类型参数过程详解,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下...2020-09-19

  • 详解java如何集成swagger组件

    今天给大家带来的是关于Java的相关知识,文章围绕着java如何集成swagger组件展开,文中有非常详细的介绍及代码示例,需要的朋友可以参考下...2021-06-22

  • swagger如何返回map字段注释

    这篇文章主要介绍了swagger如何返回map字段注释的操作，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教...2021-07-03

  • ASP.NetCore使用Swagger实战

    这篇文章主要介绍了ASP.NetCore使用Swagger实战，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧...2020-11-11

  • ASP.NET Core 5中如何生成PDF文档

    这篇文章主要给大家介绍了关于ASP.NET Core 5中如何生成PDF文档的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧...2021-03-20

  • SpringBoot如何优雅的整合Swagger Api自动生成文档

    在多人协作的开发过程中,API文档不仅可以减少等待,也能保证开发的持续进行,这篇文章主要给大家介绍了关于SpringBoot如何优雅的整合Swagger Api自动生成文档的相关资料,需要的朋友可以参考下...2021-07-08

  • Asp.net Core Jenkins Docker实现一键化部署的实现

    这篇文章主要介绍了Asp.net Core Jenkins Docker实现一键化部署的实现，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧...2021-09-22

  • Java集成swagger文档组件

    这篇文章主要介绍了Java集成swagger文档组件,通过详细的图文介绍和代码分析展示,从头展开说明详细的过程,希望对你的开发有所帮助...2021-06-29

  • 理解ASP.NET Core 启动类(Startup)

    这篇文章主要介绍了ASP.NET Core 启动类(Startup)，文中运用代码讲解相关知识非常详细，感兴趣的小伙伴可以参考一下...2021-09-22

  • ASP.NET Core中实现全局异常拦截的完整步骤

    这篇文章主要给大家介绍了关于ASP.NET Core中如何实现全局异常拦截的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧...2021-09-22

  • Asp.net core WebApi 使用Swagger生成帮助页实例

    本篇文章主要介绍了Asp.net core WebApi 使用Swagger生成帮助页实例，具有一定的参考价值，感兴趣的小伙伴们可以参考一下。...2021-09-22

  • Asp.Net Core WebAPI使用Swagger时API隐藏和分组详解

    这篇文章主要给大家介绍了关于Asp.Net Core WebAPI使用Swagger时API隐藏和分组的相关资料，文中通过示例代码介绍的非常详细，对大家学习或者使用Asp.Net Core具有一定的参考学习价值，需要的朋友们下面来一起学习学习吧...2021-09-22