有没有一种方法可以从预先使用的C#Azure函数自动生成Swagger标记? [英] Is there a way to automatically generate Swagger tags from precomipled C# Azure Functions?

问题描述

有人知道任何可用于注释预编译的C#Azure函数的.NET属性，以便它可以自动生成Swagger标记吗?例如，我想在Swagger中自动生成标签"条目:

Is anyone aware of any .NET attributes that can be used to annotate a precompiled C# Azure Function so it can generate Swagger tags automatically? For example, I would like to auto-generate the "tags" entry in Swagger:

/api/v1/revision:
    get:
      operationId: /api/v1/revision/get
      tags:
        - System
      produces: []
      consumes: []
      parameters: []
      description: Gets the API version
      responses:
        '200':
          description: Success operation
      security:
        - apikeyQuery: []

这是我的C#函数:

 public static class VersioningService
    {
        [FunctionName("ApiVersion")]
        public static async Task<HttpResponseMessage> ApiVersion([HttpTrigger(AuthorizationLevel.Function, "get", Route = "v1/revision")]HttpRequestMessage req, TraceWriter log)
        {
            return req.CreateResponse(HttpStatusCode.OK, "<p>API Version: 1.0340");
        }
    }

推荐答案

找到了这篇文章:

• 我已经使用powershell完成了这些步骤.
  该脚本假定您已经配置了host.json文件:

  I've impletemented the steps using powershell.
  The script assumes that you have a configured host.json file:

  {
    "swagger": {
      "enabled": true
    }
  }
  

  此脚本仅适用于Azure Function运行时v1，尚未为运行时v2实现草草生成

  This script only work for Azure Function runtime v1, swagger generation is not yet implemented for runtime v2

  function Get-KuduApiAuthorisationHeaderValueAzure {
      Param
      (
          [Parameter(Mandatory = $true)]
          [string]$resourceGroupName,
          [Parameter(Mandatory = $true)]
          [string]$functionappName
      )
      Begin {               
          $resourceType = "Microsoft.Web/sites/config"
          $resourceName = "$functionappName/publishingcredentials"
          $publishingCredentials = Invoke-AzureRmResourceAction -ResourceGroupName $resourceGroupName -ResourceType $resourceType -ResourceName $resourceName -Action list -ApiVersion 2015-08-01 -Force
  
          $base64AuthInfo = [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes(("{0}:{1}" -f $publishingCredentials.Properties.PublishingUserName, $publishingCredentials.Properties.PublishingPassword)))
          return $base64AuthInfo
      }
  }
  
  function Get-MasterAPIKey {
      Param
      (
          [Parameter(Mandatory = $true)]
          [string]$resourceGroupName,
          [Parameter(Mandatory = $true)]
          [string]$functionappName
      )
      Begin {               
          $kuduApiAuthorisationToken = Get-KuduApiAuthorisationHeaderValueAzure -resourceGroupName $resourceGroupName -functionappName $functionappName
          $apiUrl = "https://$functionappName.scm.azurewebsites.net/api/functions/admin/masterkey"
          $response = Invoke-RestMethod -Uri $apiUrl -Headers @{Authorization = ("Basic {0}" -f $kuduApiAuthorisationToken);"If-Match"="*"}
          return $response.masterKey
      }
  }
  
  function Get-FunctionsApiJwt {
      Param
      (
          [Parameter(Mandatory = $true)]
          [string]$resourceGroupName,
          [Parameter(Mandatory = $true)]
          [string]$functionappName
      )
      Begin {               
          $base64AuthInfo = Get-KuduApiAuthorisationHeaderValueAzure -resourceGroupName $resourceGroupName -functionappName $functionappName
          $apiUrl = "https://$functionappName.scm.azurewebsites.net/api/functions/admin/token"
          $jwt = Invoke-RestMethod -Uri $apiUrl -Headers @{Authorization = ("Basic {0}" -f $base64AuthInfo)} -Method GET
  
          return $jwt
      }
  }
  
  function Generate-SwaggerDefinition {
      Param
      (
          [Parameter(Mandatory = $true)]
          [string]$resourceGroupName,
          [Parameter(Mandatory = $true)]
          [string]$functionappName
      )
      Begin {   
  
          # Get the swagger documentation key
          $masterKey = Get-MasterAPIKey -resourceGroupName $resourceGroupName -functionappName $functionappName
          $apiUrl = "https://$functionappName.azurewebsites.net/admin/host/systemkeys/swaggerdocumentationkey"
          $swaggerdocumentationkey = (Invoke-RestMethod -Uri $apiUrl -Headers @{"x-functions-key"=$masterKey} -Method Post).value
  
          # Update the resource
          $config = Get-AzureRmResource -ResourceGroupName $resourceGroupName -ResourceType "microsoft.web/sites/config" -Name "$functionappName/web" -ApiVersion "2015-08-01"
          $config.Properties.apiDefinition = @{"url"="https://$functionappName.azurewebsites.net/admin/host/swagger?code=$swaggerdocumentationkey"}
          $config | Set-AzureRmResource -Force -ApiVersion "2015-08-01"
  
          # Generate the swagger definition
          $jwt = Get-FunctionsApiJwt -resourceGroupName $resourceGroupName -functionappName $functionappName
          $swaggerDefinition = (Invoke-RestMethod -Uri "https://$functionappName.azurewebsites.net/admin/host/swagger/default?code=$swaggerdocumentationkey" -Headers @{Authorization=("Bearer {0}" -f $jwt)} -Method Get)
  
          # Save the swagger definition
          Invoke-RestMethod -Uri "https://$functionappName.azurewebsites.net/admin/host/swagger?code=$swaggerdocumentationkey" -ContentType 'application/json' -Headers @{Authorization=("Bearer {0}" -f $jwt)} -Method Post -Body (ConvertTo-Json $swaggerDefinition -Depth 100)
      }
  }
  

  您可以这样调用该脚本:

  you can call this script like that:

  Generate-SwaggerDefinition -resourceGroupName "myresourcegroupname" -functionappName "myfunctionappname"
  

  编辑

  新创建的功能应用程序默认情况下使用TLS 1.2，因此您需要在Powershell脚本顶部添加以下行:

  Newly created function apps use TLS 1.2 by default so you need to add this line at the top of the Powershell script:

  [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
  

  这篇关于有没有一种方法可以从预先使用的C#Azure函数自动生成Swagger标记?的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！