在 ASP.NET Core Web API 项目中,Swagger 是一个非常有用的工具,它可以帮助开发人员生成和展示 API 文档。然而,有时我们会遇到一些棘手的问题,例如如何正确地将授权头信息(如 “Authorization”)包含在 Swagger 的 swagger.json
文件中。本文将详细探讨这一问题,并提供解决方案。
背景
在使用 ASP.NET Core 8.0 开发的 Web API 项目中,我们希望将授权头信息正确地输出到 Swagger 的文档中,但发现 swagger.json
文件中并没有包含预期的 “Authorization” 头信息。
问题描述
-
没有错误输出:在构建和运行项目时,
MyProject.xml
文件正确生成,但swagger.json
文件中没有 “Authorization” 头信息。 -
检查配置:确认已在
MyProject.csproj
中启用文档生成,并且 XML 注释文件已被正确包含。 -
Swagger 配置:
builder.Services