我可以将 Swashbuckle 用于与端点不相关的多个文档吗？

Question

我正在构建一个 ASP.NET Core Web API，使用 Swashbuckle 生成一个 swagger 文档页面。我已经使用 Info 对象来自定义描述，但我想知道 Swashbuckle 是否支持添加其他文档。例如，架构文档、示例应用程序等。超出了我想要放入描述中的内容。我知道我可以在 Into.Description 中包含指向其他页面的链接，但我希望重用 swagger 页面的格式和视觉效果，因此它看起来大致相同。

Swashbuckle 是否支持链接此的其他页面？

Answer 1

Swashbuckle 旨在为您的 WebApi 生成 swagger 文档 (OAS 2.0)，并且该 swagger 文档受该规范的限制：
https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md

另一个限制是 UI，Swashbuckle 使用 Swagger-UI，这是一个单独的项目，它确实提供了一些自定义功能，但恐怕不是您想要的：
https://github.com/swagger-api/swagger-ui#documentation

Swashbuckle 具有注入资产和自定义登陆页面的选项： https://github.com/domaindrivendev/Swashbuckle.AspNetCore/blob/master/README.md#inject-custom-css

好处是 Swashbuckle 和 Swagger-UI 都是开源的，所以如果您需要更改核心功能，您可以！

Answer 2

您可以将 javascript 文件注入到 swagger UI 中。然后你可以使用这个js插入其他页面的链接。这些其他页面可以添加对默认 swagger UI 的 CSS 文件的引用，以便它们具有 swagger UI 的一些外观和感觉。