如何在Azure DevOps YAML管道中为InvokeRESTAPI@1程序化提供请求体

1. 无代理作业能否使用代理作业的输出？ #

无代理作业（Server Job）不能直接引用代理作业的输出变量，但可以通过发布+下载构建工件（Artifact）的方式获取代理作业生成的文件（比如你的output.json），这也是你当前配置里已经在做的操作。不过要注意：无代理作业里的文件操作只能用云端支持的无代理任务，没法用需要代理的脚本任务直接读取文件内容。

2. 怎么把output.json配置到InvokeRESTAPI@1的Body参数中？ #

你现在直接填文件路径的方式不对，InvokeRESTAPI@1的Body需要的是请求体的实际字符串内容，不是文件路径。针对无代理作业的限制，给你两种可行方案：

方案一：用FileTransform@1读取文件内容到变量（推荐） #

在下载完Artifact之后，添加FileTransform@1任务把JSON文件内容读取成管道变量，再在InvokeRESTAPI@1里引用这个变量：

- job: 'SendReleaseNotes'
  dependsOn: GetReleaseNotes
  pool: server
  steps:
  - task: DownloadBuildArtifacts@0
    inputs:
      buildType: 'current'
      downloadType: 'single'
      artifactName: 'ReleaseNotesJson'
      downloadPath: '$(Build.ArtifactStagingDirectory)'
      cleanDestinationFolder: true
    displayName: 'Download Notes to WorkingDir'
  - task: FileTransform@1
    inputs:
      folderPath: '$(Build.ArtifactStagingDirectory)/ReleaseNotesJson'
      fileType: 'json'
      targetFiles: 'output.json'
    name: ReadJsonContent
    displayName: 'Read JSON content to variable'
  - task: InvokeRESTAPI@1
    inputs:
      connectionType: 'connectedServiceName'
      serviceConnection: 'CustomerPortal_ReleaseNotes_Post_Api'
      method: 'POST'
      body: |
        $(ReadJsonContent.outputJson)
      waitForCompletion: 'true'

提示：FileTransform@1是无代理作业支持的任务，它会自动把JSON文件的内容赋值为{任务名}.outputJson格式的变量。

方案二：在代理作业中直接输出JSON内容为变量 #

如果output.json内容不大，可以跳过发布Artifact的步骤，直接在代理作业里把JSON内容输出成管道变量，然后无代理作业直接引用：

- job: 'GetReleaseNotes'
  pool:
    name: MehdiPool
  steps:
    - checkout: self
    - task: PowerShell@2
      inputs:
        filePath: 'ReleaseNotesPipelines/pipeline-scripts/3_PostUpdates.ps1'
        arguments: >
          -PAT $(PAT)
          -ProjectName $(System.TeamProject)
          -ReleaseNotesRepo "ReleaseNotes"
          -Since $(Since)
          -Until $(Until)
      displayName: 'Create Post Data'
      name: 'CreatePostData'
    - task: PowerShell@2
      inputs:
        targetType: 'inline'
        script: |
          $jsonContent = Get-Content -Path "$(Build.ArtifactStagingDirectory)/output.json" -Raw
          Write-Host "##vso[task.setvariable variable=releaseNotesJson;isOutput=true]$jsonContent"
      name: 'SetJsonVariable'
      displayName: 'Set JSON content as output variable'
- job: 'SendReleaseNotes'
  dependsOn: GetReleaseNotes
  pool: server
  variables:
    releaseNotesJson: $[ dependencies.GetReleaseNotes.outputs['SetJsonVariable.releaseNotesJson'] ]
  steps:
  - task: InvokeRESTAPI@1
    inputs:
      connectionType: 'connectedServiceName'
      serviceConnection: 'CustomerPortal_ReleaseNotes_Post_Api'
      method: 'POST'
      body: |
        $(releaseNotesJson)
      waitForCompletion: 'true'

这个方案更高效，但要注意管道变量有内容长度限制（一般不超过4MB），如果JSON太大就用方案一。

3. 如何为InvokeRESTAPI@1程序化提供请求体？ #

除了上面两种方法，还有这些思路：

• 确保请求体是合法的JSON字符串，同时在InvokeRESTAPI@1的headers参数里设置Content-Type: application/json，避免API解析错误；
• 所有动态生成请求体的逻辑尽量放在代理作业里完成，因为无代理作业没法执行复杂的脚本，生成好内容后再通过变量或Artifact传递过去。

内容的提问来源于stack exchange，提问作者Mehdi