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");
});
然后，就可以使用了，请求对应地址 localhost:44375/swagger/index.html，现在就可以看到示例代码中的WeatherForecast.cs了。
到此这篇关于ASP.NetCore使用Swagger实战的文章就介绍到这了,更多相关ASP.NetCore使用Swagger内容请搜索华域联盟以前的文章或继续浏览下面的相关文章希望大家以后多多支持华域联盟！
您可能感兴趣的文章:Asp.Net Core使用swagger生成api文档的完整步骤asp.net core 3.0中使用swagger的方法与问题Asp.Net Core WebAPI使用Swagger时API隐藏和分组详解记Asp.Net Core Swagger使用并带域接口处理的方法Asp.net core WebApi 使用Swagger生成帮助页实例
ASP.NetCore
Swagger
相关文章
asp.net中不能在DropDownList中选择多个项 原因分析及解决方法不能在 DropDownList 中选择多个项,在前一步操作的过程中，已经选择了某个Item 2012-10-10
Asp.net response对象与request对象使用介绍这篇文章主要介绍了Asp.net response对象与request对象使用,需要的朋友可以参考下 2014-04-04
asp.net DropDownList实现二级联动效果这篇文章主要介绍了asp.net DroDownList实现二级联动效果的相关资料,需要的朋友可以参考下 2016-02-02
.NET获取枚举DescriptionAttribute描述信息性能改进的多种方法这篇文章主要介绍了.NET获取枚举DescriptionAttribute描述信息性能改进的多种方法 的相关资料,需要的朋友可以参考下 2016-01-01
ASP.NET中利用DataList实现图片无缝滚动 实例分享这个问题之前也困扰我，后来解决了，拿出来分享下，以后用也方便，代码很容易看懂，不多说什么了 2013-06-06
.Net集合排序的一种高级玩法实例教程这篇文章主要给大家介绍了关于.Net集合排序的一种高级玩法的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧 2018-05-05
ASP.NET自定义Web服务器控件之Button控件这篇文章主要介绍了ASP.NET自定义Web服务器控件之Button控件,详细讲述了Button控件的实现代码、前台页面的调用以及对应的事件响应代码,具有很好的参考借鉴价值,需要的朋友可以参考下 2014-11-11
asp.net发布后web.config中compilation的debug的值true和false区在本篇文章里小编给大家整理的是一篇关于asp.net发布后web.config中compilation的debug的值true和false区别点内容，有需要的为朋友们可以参考下。 2020-01-01
IdentityServer4实现.Net Core API接口权限认证(快速入门)这篇文章主要介绍了IdentityServer4实现.Net Core API接口权限认证，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧 2020-03-03
ASP.NET MVC学习之NuGet在VS中的运用浅谈这篇文章主要给大家介绍了关于ASP.NET MVC学习之NuGet在VS中运用的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面来一起学习学习吧。 2018-01-01
最新评论
本文由 华域联盟 原创撰写：华域联盟 » ASP.NetCore使用Swagger实战
转载请保留出处和原文链接：https://www.cnhackhy.com/5031.htm
