Compartilhar via


Chamar uma API REST

Azure DevOps Services | Azure DevOps Server | Azure DevOps Server 2022

Dica

Para obter as diretrizes mais recentes de desenvolvimento de extensão, incluindo temas e migração do VSS. SDK, consulte o portal do desenvolvedor do SDK de Extensão do Azure DevOps.

Para chamar uma API REST de sua extensão, primeiro obtenha o serviço cliente e, em seguida, use-o para chamar a API.

Observação

Procurando APIs REST do Azure DevOps? Consulte a referência mais recente da API REST do Azure DevOps.

Para obter informações sobre bibliotecas de clientes .NET, consulte bibliotecas de clientes do .NET para Azure DevOps.

Chamar uma API

Adicione o escopo "scopes": ["vso.work"], ao seu vss-extension.json para usar o cliente de acompanhamento de itens de trabalho.

  1. Obtenha o cliente REST. Neste exemplo, use o cliente de rastreamento de itens de trabalho.

    import * as SDK from "azure-devops-extension-sdk";
    import { WorkItemTrackingRestClient } from "azure-devops-extension-api/WorkItemTracking";
    import { getClient } from "azure-devops-extension-api";
    
    SDK.init();
    SDK.ready().then(async () => {
        const witClient = getClient(WorkItemTrackingRestClient);
        // ...
    });
    
  2. Chame a API, getWorkItems, usando o cliente com um retorno de chamada que manipula os resultados.

    const workItems = await witClient.getWorkItems([1, 2, 3, 4], undefined, ["System.Title"]);
    console.log(JSON.stringify(workItems));