Criar Plugin de API TypeSpec

Crie um plugin completo de API TypeSpec para o Microsoft 365 Copilot que se integra com APIs REST externas.

Requisitos

Gere arquivos TypeSpec com:

main.tsp - Definição do Agente

import "@typespec/http";
import "@typespec/openapi3";
import "@microsoft/typespec-m365-copilot";
import "./actions.tsp";

using TypeSpec.Http;
using TypeSpec.M365.Copilot.Agents;
using TypeSpec.M365.Copilot.Actions;

@agent({
  name: "[Agent Name]",
  description: "[Description]"
})
@instructions("""
  [Instructions for using the API operations]
""")
namespace [AgentName] {
  // Reference operations from actions.tsp
  op operation1 is [APINamespace].operationName;
}

actions.tsp - Operações da API

import "@typespec/http";
import "@microsoft/typespec-m365-copilot";

using TypeSpec.Http;
using TypeSpec.M365.Copilot.Actions;

@service
@actions(#{
    nameForHuman: "[API Display Name]",
    descriptionForModel: "[Model description]",
    descriptionForHuman: "[User description]"
})
@server("[API_BASE_URL]", "[API Name]")
@useAuth([AuthType]) // Optional
namespace [APINamespace] {
  
  @route("[/path]")
  @get
  @action
  op operationName(
    @path param1: string,
    @query param2?: string
  ): ResponseModel;

  model ResponseModel {
    // Response structure
  }
}

Opções de Autenticação

Escolha com base nos requisitos da API:

1. Sem Autenticação (APIs Públicas)

   // No @useAuth decorator needed
   

2. Chave de API

   @useAuth(ApiKeyAuth<ApiKeyLocation.header, "X-API-Key">)
   

3. OAuth2

   @useAuth(OAuth2Auth<[{
     type: OAuth2FlowType.authorizationCode;
     authorizationUrl: "https://oauth.example.com/authorize";
     tokenUrl: "https://oauth.example.com/token";
     refreshUrl: "https://oauth.example.com/token";
     scopes: ["read", "write"];
   }]>)
   

4. Referência de Autenticação Registrada

   @useAuth(Auth)
   
   @authReferenceId("registration-id-here")
   model Auth is ApiKeyAuth<ApiKeyLocation.header, "X-API-Key">
   

Capacidades da Função

Caixa de Diálogo de Confirmação

@capabilities(#{
  confirmation: #{
    type: "AdaptiveCard",
    title: "Confirm Action",
    body: """
    Are you sure you want to perform this action?
      * **Parameter**: {{ function.parameters.paramName }}
    """
  }
})

Resposta com Cartão Adaptativo

@card(#{
  dataPath: "$.items",
  title: "$.title",
  url: "$.link",
  file: "cards/card.json"
})

Instruções de Raciocínio e Resposta

@reasoning("""
  Consider user's context when calling this operation.
  Prioritize recent items over older ones.
""")
@responding("""
  Present results in a clear table format with columns: ID, Title, Status.
  Include a summary count at the end.
""")

Melhores Práticas

1. Nomes de Operação: Use nomes claros e orientados para ação (listProjects, createTicket)
2. Modelos: Defina modelos semelhantes a TypeScript para requisições e respostas
3. Métodos HTTP: Use verbos apropriados (@get, @post, @patch, @delete)
4. Caminhos: Use convenções de caminho RESTful com @route
5. Parâmetros: Use @path, @query, @header, @body apropriadamente
6. Descrições: Forneça descrições claras para o entendimento do modelo
7. Confirmações: Adicione para operações destrutivas (excluir, atualizar dados críticos)
8. Cartões: Use para respostas visuais ricas com múltiplos itens de dados

Fluxo de Trabalho

Pergunte ao usuário:

1. Qual é a URL base da API e o propósito?
2. Quais operações são necessárias (operações CRUD)?
3. Qual método de autenticação a API usa?
4. Confirmações devem ser exigidas para alguma operação?
5. As respostas precisam de Cartões Adaptativos?

Em seguida, gere:

• main.tsp completo com a definição do agente
• actions.tsp completo com as operações da API e modelos
• cards/card.json opcional se Cartões Adaptativos forem necessários