Swashbuckle 和 ASP.NET Core 入门

Swagger UI 提供了基于 Web 的 UI，它使用生成的 OpenAPI 规范提供有关服务的信息。 Swashbuckle 和 NSwag 均包含 Swagger UI 的嵌入式版本，因此可使用中间件注册调用将该嵌入式版本托管在 ASP.NET Core 应用中。 Web UI 如下所示：

控制器中的每个公共操作方法都可以从 UI 中进行测试。选择方法名称可以展开该部分。添加所有必要的参数，然后选择“试试看!”。

一、WebAPI 项目中添加 SwaggerUI

从“管理 NuGet 程序包”对话框中：

在搜索框中输入“Swashbuckle.AspNetCore”

Swashbuckle 有三个主要组件(分别引用以下三个组件)：

Swashbuckle.AspNetCore.Swagger：将 SwaggerDocument 对象公开为 JSON 终结点的 Swagger 对象模型和中间件。
Swashbuckle.AspNetCore.SwaggerGen：从路由、控制器和模型直接生成 SwaggerDocument 对象的 Swagger 生成器。它通常与 Swagger 终结点中间件结合，以自动公开 Swagger JSON。
Swashbuckle.AspNetCore.SwaggerUI：Swagger UI 工具的嵌入式版本。它解释 Swagger JSON 以构建描述 Web API 功能的可自定义的丰富体验。它包括针对公共方法的内置测试工具。

二、添加并配置 Swagger 中间件

将 Swagger 生成器添加到 Program.cs 中的服务集合：

// Add services to the container.builder.Services.AddControllersWithViews();
builder.Services.AddRazorPages();//SwaggerGen 将生成器添加到服务集合
builder.Services.AddSwaggerGen(c =>
{c.SwaggerDoc("v1",new Microsoft.OpenApi.Models.OpenApiInfo { Title ="Swagger项目",Version ="v1"});
});var app = builder.Build();

在 Program.cs 中，启用中间件为生成的 JSON 文档和 Swagger UI 提供服务：

if (app.Environment.IsDevelopment())
{app.UseWebAssemblyDebugging();app.UseSwagger();//启用中间件为生成的 JSON 文档和 Swagger UI 提供服务app.UseSwaggerUI();//启用中间件为生成的 JSON 文档和 Swagger UI 提供服务
}
else
{app.UseExceptionHandler("/Error");// The default HSTS value is 30 days. You may want to change this for production scenarios, see https://aka.ms/aspnetcore-hsts.app.UseHsts();
}

仅当将当前环境设置为“开发”时，上述代码才会添加 Swagger 中间件。 UseSwaggerUI 方法调用启用了静态文件中间件。

启动应用,可在 https://localhost:<port>/swagger 找到 Swagger UI。通过 Swagger UI 浏览 API

导航到 https://localhost:<port>/swagger/v1/swagger.json。生成的描述终结点的文档显示在 OpenAPI 规范 (openapi.json) 中。

Web API 项目中启用 Swagger UI相关推荐

【转】Web API项目中使用Area对业务进行分类管理
在之前开发的很多Web API项目中,为了方便以及快速开发,往往把整个Web API的控制器放在基目录的Controllers目录中,但随着业务越来越复杂,这样Controllers目录中的文件就增加 ...
oracle web API,在Web API程序中使用Swagger做接口文档
#### 创建Web API程序在VS2019中创建一个ASP.NET Web应用程序,选择Web API来创建RESTful的HTTP服务项目,构选MVC和Web API核心引用. #### 安装 ...
core webapi缩略图_在ASP.NET Core Web API 项目里无法访问（wwwroot）下的文件
新建 ASP.NET Core Web API 项目 -- RESTFul 风格 Hello World! 一.创建一个空项目请查看新建 .NET Core 项目 -- Hello World! ...
【WEB API项目实战干货系列】- API登录与身份验证(三)
上一篇: [WEB API项目实战干货系列]- 接口文档与在线测试(二) 这篇我们主要来介绍我们如何在API项目中完成API的登录及身份认证. 所以这篇会分为两部分, 登录API, API身份验证. ...
ASP.NET Core 2.0 Web API项目升级到ASP.NET Core 3.0概要笔记
本文结构先决条件升级目标框架(Target Framework)的版本过时的IHostingEnvironment与IApplicationLifetime对象 Endpoint Routing ...
【WEB API项目实战干货系列】- 接口文档与在线测试(二)
这一篇我们主要介绍如何做API帮助文档,给API的调用人员介绍各个 API的功能, 输入参数,输出参数, 以及在线测试 API功能(这个也是方便我们自己开发调试) 我们先来看看我们的API最终帮助文档 ...
我如何启动任何.NET Core Web API项目
目录介绍步骤在Visual Studio中创建Web API项目选项1 选项 2 IIS配置配置Swashbuckle/Swagger 添加Swashbuckle 添加Newtonsoft. ...
ASP.NET创建一个web程序Vs创建一个Web API项目
ASP.NET创建一个web程序首先windows+r调出控制台,按照下面的命令创建WebApp应用: dotnet new webapp -o MyWebApp --no-https -f net ...
国产中标麒麟Linux部署dotnet core 环境并运行项目（三）部署运行WEB API项目
部署dotnet Core Web API 上一步的文章,是我们公司最核心的一个ORM组件,在中标麒麟系统完成了一个插入数据的任务,这一步是将正式的从dot net framework 迁移到 dot ...

Web API 项目中启用 Swagger UI

Swashbuckle 和 ASP.NET Core 入门

一、WebAPI 项目中添加 SwaggerUI

二、添加并配置 Swagger 中间件

Web API 项目中启用 Swagger UI相关推荐

最新文章

热门文章