脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 网络编程 → ASP.NET → 实用技巧 → ASP.NetCore使用Swagger

ASP.NetCore使用Swagger实战

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

踩坑不背锅，.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内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

相关文章

  • ASP.NET过滤HTML标签只保留换行与空格的方法

    ASP.NET过滤HTML标签只保留换行与空格的方法

    这篇文章主要介绍了ASP.NET过滤HTML标签只保留换行与空格的方法,包含网上常见的方法以及对此方法的改进,具有一定的参考借鉴价值,需要的朋友可以参考下
    2014-12-12
  • .Net Api 中使用Elasticsearch存储文档的方法

    .Net Api 中使用Elasticsearch存储文档的方法

    Elasticsearch 是一个分布式、高扩展、高实时的搜索与数据分析引擎，在C# 的环境中，有一个Es的官方拓展包Nest，可以让我们方便快捷的使用上Es数据库，本文重点给大家介绍.Net Api 中使用Elasticsearch存储文档的方法，感兴趣的朋友一起看看吧
    2022-01-01
  • ASP.NET Core 实现基本认证的示例代码

    ASP.NET Core 实现基本认证的示例代码

    这篇文章主要介绍了ASP.NET Core 实现基本认证的示例代码吗，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2020-10-10
  • asp.net运算符之逻辑运算符以及其他运算符介绍与实例

    asp.net运算符之逻辑运算符以及其他运算符介绍与实例

    在.net中运算符分类很多种类型，包括有我们常用的boolean型运算符，通用的运行符有 ==、!=、<、>、<=、>=、binary +、binary -、^、&、|、~、++、-- 和 sizeof()
    2013-08-08
  • ASP.NET Core中使用xUnit进行单元测试

    ASP.NET Core中使用xUnit进行单元测试

    这篇文章主要介绍了ASP.NET Core中使用xUnit进行单元测试，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
    2017-11-11
  • ASP.NET MVC3手把手教你构建Web

    ASP.NET MVC3手把手教你构建Web

    微软更新速度一直都是很快，目前最新版本是ASP.NET MVC 5.1，而我还在刚刚起步研究MVC3.0。本文是MVC的基础，构建最简单的MVC项目，感兴趣的小伙伴们可以参考一下
    2015-09-09
  • .NET 6开发TodoList应用之实现查询排序

    .NET 6开发TodoList应用之实现查询排序

    这篇文章主要介绍了如何通过.NET 6实现查询排序功能，文中的示例代码讲解详细，对我们学习.NET 6有一定的帮助，感兴趣的同学可以了解一下
    2022-01-01
  • asp.net类序列化生成xml文件实例详解

    asp.net类序列化生成xml文件实例详解

    这篇文章主要介绍了asp.net类序列化生成xml文件的方法,结合实例形式较为详细的分析了asp.net序列化生成xml文件的具体步骤与相关实现技巧,需要的朋友可以参考下
    2015-11-11
  • CefSharp v62修改方法(支持.net4.0)

    CefSharp v62修改方法(支持.net4.0)

    下面小编就为大家分享一篇CefSharp v62修改方法(支持.net4.0)，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
    2017-12-12
  • NET Core TagHelper实现分页标签

    NET Core TagHelper实现分页标签

    这篇文章主要介绍了NET Core TagHelper实现分页标签，讲述实现一个简单分页和总要注意步奏，感兴趣的小伙伴们可以参考一下
    2016-07-07

最新评论