typespec-create-api-plugin 是做什么的？
为 Microsoft 365 Copilot 生成包含 REST 操作、身份验证和自适应卡片的 TypeSpec API 插件。
此技能可自动创建 TypeSpec 定义，包括 REST API 操作、身份验证配置（如 OAuth2 或 API Key）以及自适应卡片模板，以便将您的服务快速集成到 Microsoft 365 Copilot 中。它遵循官方最佳实践，适用于各种 AI 开发环境。
使用场景
- 为 Microsoft 365 Copilot 创建新的 API 插件
- 快速原型设计 REST 操作和身份验证
- 生成自适应卡片以增强 Copilot 对话体验
前提条件
- 安装 TypeSpec 编译器 (
tsp) 和 Node.js 18+ - 了解 Microsoft 365 Copilot 插件概念
使用方法
在 AI 终端（如 Claude Code、Cursor 或 Codex）中运行以下命令：
npx @typespec/create-api-plugin my-copilot-plugin
此命令将生成包含以下内容的项目结构：
main.tsp：主 TypeSpec 文件，定义 REST 操作和模型authentication.tsp：身份验证配置adaptive-cards/：自适应卡片模板目录tspconfig.yaml：TypeSpec 编译器配置
示例输出
生成的 main.tsp 文件示例：
import "@typespec/http";
import "@typespec/rest";
@service({
title: "My Copilot Plugin",
})
namespace MyApi {
model TodoItem {
id: string;
title: string;
completed?: boolean;
}
@route("/todos")
interface Todos {
@get list(): TodoItem[];
@post create(@body item: TodoItem): TodoItem;
}
}
身份验证配置
生成的 authentication.tsp 示例：
import "@typespec/http";
@useAuth(AuthorizationCodeFlow<CredentialScopes>)
namespace AuthenticatedApi {
model CredentialScopes {
scopes: ["https://api.example.com/.default"];
}
}
自适应卡片
生成的 adaptive-cards/todo-card.json 示例：
{
"type": "AdaptiveCard",
"version": "1.5",
"body": [
{
"type": "TextBlock",
"text": "${title}",
"size": "Medium"
}
]
}
相关资源
支持平台
- Claude Code
- Cursor
- Codex
- 任何支持 TypeScript/Node.js 的 AI 开发终端