Devlooped.Azure.Functions.OpenApi 0.3.1

C# Azure Functions 的 OpenAPI/Swagger 生成器

为 C# Azure Functions 提供零代码基础 OpenAPI (Swagger) 生成器。

使用方法

只需安装软件包并运行应用程序。默认情况下，您将获得一个返回 Swagger UI 的端点 openapi，该 UI 允您浏览您的 API，以及包含标准 swagger.json 文件的端点。生成的 Swagger 文件将包含编译中的所有 HTTP 触发函数。

这假设在 host.json 中已将 routePrefix 配置为空（以覆盖默认的 /api）。

{
  ...
  "extensions": {
    "http": {
      "routePrefix": ""
    }
  }
}

打开 openapi 端点会渲染 SwaggerUI

生成的 swagger.json 可以在项目的中间输出路径中检查（默认情况下，obj\Debug\[TFM]\openapi\v2\swagger.json）。

《swagger.json》以及函数端点在构建时由一个C#源码生成器生成。因此，您可以通过将项目属性EmitCompilerGeneratedFiles设置为true来检查生成的代码，例如：

  <PropertyGroup>
    <EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles>
  </PropertyGroup>

这将将在$(IntermediateOutputPath)\generated\Devlooped.Azure.Functions.OpenApi\SourceGenerator下生成函数源文件。

自定义

有几种方法可以自定义生成过程，所有这些方法都由MSBuild驱动。

主要的生成驱动器是一个MSBuild项目项OpenApi，它包含各种元数据以调整输出。其项目定义如下：

  <ItemDefinitionGroup>
    <OpenApi>
      <Title />
      <Description />
      <Version />
      <Route />
      <Url />
      <SchemaVersion>2</SchemaVersion>
    </OpenApi>
  </ItemDefinitionGroup>

如果没有提供<OpenApi Include="..">，则自动添加，并应用默认值。

默认值如下：

• 标题：首先尝试从$(AssemblyTitle)、$(Product)、$(ProductName)、$(Title)中获取非空值。
• 描述：$(Description)
• 版本：首先尝试从$(Version)、$(InformationalVersion)、$(AssemblyVersion)中获取非空值。
• 路由：/openapi/v%(SchemaVersion)/swagger.json，其中默认的SchemaVersion为2。
• URL：/api或extensions.http.routePrefix，在host.json中设置为非空值时使用，否则为/。

Usage

我们还从分支和拉取请求中生成CI包，以便您可以尽快使用生成的构建。

CI源是从https://pkg.kzu.io/index.json。

包的版本规则如下：

• PR构建：42.42.42-pr[NUMBER]
• 分支构建：42.42.42-[BRANCH].[COMMITS]

赞助商

也在这里提到了!