将 Swagger UI 添加到自定义 .NET Web API

Question

我想将 Swagger UI 集成到我的 C# .Net Web API 项目中。这与传统的 Web API 项目不同，您可以在其中安装 SwashBuckle 之类的工具，然后获取控制器类中定义的 HTTP 路由并创建 UI。

我拥有的是一个自定义实现，它为不同的路由生成 OpenAPI/Swagger 3.0 yaml 文件。

我在一个接受变量的通用控制器文件中定义了一个路由 -

http://localhost:8000/myapp/swagger/{document_name}

其中 document_name 是一个变量。我的代码采用此变量并根据此值生成自定义文档。

http://localhost:8000/myapp/swagger/sedan
http://localhost:8000/myapp/swagger/suv

在上面的示例中，我的代码将为轿车和 suv 返回不同的 Open API 规范。

到目前为止，该 URL 仅以纯文本形式返回 Open API 3.0 YAML 规范。我想要做的是能够在类似于此的 Swagger UI 中表示此文件-

http://petstore.swagger.io/

这可能吗？我可以为此使用 Swashbuckle 吗？我是否需要进行自定义实现来托管 Swagger UI？最好的方法是什么？

Answer 1

如果您已经拥有 OpenAPI/Swagger 3.0 yaml 文件，那么您只需要 UI 并且您有几个选项：

• 将 UI 文件复制到您的服务器。
  这将为您提供最大的灵活性，允许您使用configuration parameters 进行自定义
  您只需要 dist 文件夹中的文件：
  https://github.com/swagger-api/swagger-ui/tree/master/dist

• 使用 petstore 或任何其他现有 UI 并将您的文件作为参数传递，如下所示：
  http://petstore.swagger.io/?url=https://raw.githack.com/heldersepu/hs-scripts/master/swagger/swagger_aws.json