typespec-create-api-plugin

创建 TypeSpec API 插件

为 Microsoft 365 Copilot 创建一个完整的 TypeSpec API 插件，用于与外部 REST API 集成。

要求

生成 TypeSpec 文件，包含：

main.tsp - Agent 定义

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 - 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
  }
}

身份验证选项

根据 API 要求选择：

1. 无身份验证（公共 API）

   // No @useAuth decorator needed
   

2. 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. 已注册的身份验证引用

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

功能能力

确认对话框

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

自适应卡片响应

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

推理与响应指令

@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.
""")

最佳实践

1. 操作名称：使用清晰、面向操作的名称（listProjects、createTicket）
2. 模型：为请求和响应定义类似 TypeScript 的模型
3. HTTP 方法：使用合适的动词（@get、@post、@patch、@delete）
4. 路径：使用符合 RESTful 规范的路径约定并配合 @route
5. 参数：适当使用 @path、@query、@header、@body
6. 描述：提供清晰的描述以便模型理解
7. 确认：为破坏性操作添加确认（删除、更新关键数据）
8. 卡片：用于包含多个数据项的丰富可视化响应

工作流

询问用户：

1. API 的基础 URL 和用途是什么？
2. 需要哪些操作（CRUD 操作）？
3. API 使用哪种身份验证方法？
4. 是否有任何操作需要确认？
5. 响应是否需要自适应卡片？

然后生成：

• 包含 Agent 定义的完整 main.tsp
• 包含 API 操作和模型的完整 actions.tsp
• 如果需要自适应卡片，可选的 cards/card.json