简介
Swagger是一款强大的API管理工具,它主要用于生成、描述、调用和可视化RESTful风格的Web服务。Swagger通过一套标准的规范定义接口及其相关信息,从而能够自动生成各种格式的接口文档(如HTML、PDF、Markdown等),并支持生成多种语言和客户端、服务端的代码,以及提供在线接口调试页面,极大地方便了开发人员进行接口的开发和测试。
在ASP.NET Core的Web API项目中,通常会默认注入Swagger服务,但是默认的Swagger并没有开启挈带Token配置功能。如需开启,需要在Swagger的配置中添加一些特定的设置。
默认配置
在新建的WebApi项目的Program文件中,默认会有下面这三个配置,这三行代码行是配置和使用Swagger的关键步骤。下面我们先来了解这三行代码的具体作用。
builder.Services.AddSwaggerGen();
app.UseSwagger();
app.UseSwaggerUI();
-
builder.Services.AddSwaggerGen();
这行代码是在项目的服务配置阶段调用的,它的作用是向ASP.NET Core的依赖注入(DI)容器中添加Swagger生成器的服务。Swagger生成器负责扫描你的控制器和动作,并基于这些信息生成Swagger文档(通常是一个JSON文件),这个文档描述了你的API的结构,包括可用的端点、请求方法、请求和响应格式等。
你还可以在这个调用中配置Swagger生成器的各种选项,比如文档标题、版本、要包括或排除的API控制器、安全定义等,如之前示例中所示。<