typespec-create-api-plugin 是做什麼的?
生成一個 TypeSpec API 外掛程式,其中包含 REST 操作、驗證機制及適用於 Microsoft 365 Copilot 的 Adaptive Cards。
功能
- 自動產生 REST API 操作(GET、POST、PUT、DELETE)
- 支援多種驗證方式(API 金鑰、OAuth2、Bearer Token)
- 整合 Adaptive Cards,讓 Copilot 對話更豐富
- 使用 TypeSpec 定義 API 規格
- 一鍵生成外掛程式程式碼
需求
安裝
npm install -g @typespec/compiler
使用方法
- 建立新的 TypeSpec 專案:
mkdir my-api-plugin
cd my-api-plugin
tsp init
- 執行此技能:
# 使用 Cursor 或 Codex 等工具呼叫
-
遵循提示指定 API 名稱、端點及驗證方式。
-
產生外掛程式檔案。
輸出
技能會產生以下檔案:
main.tsp- TypeSpec 規格定義plugin.json- Copilot 外掛程式設定adaptiveCards/- Adaptive Cards 範本operations/- REST 操作實作
驗證支援
| 方式 | 說明 |
|---|---|
| API 金鑰 | 透過 x-api-key 標頭傳遞 |
| OAuth2 | 支援授權碼流程 |
| Bearer Token | JWT 或自訂 Token |
自訂 Adaptive Cards
可在 adaptiveCards/ 目錄中修改範本以符合您的使用案例。如需詳細資訊,請參閱 Adaptive Cards 文件。
疑難排解
- 確保 TypeSpec CLI 已正確安裝:
tsp --version - 驗證 Node.js 版本:
node --version - 檢查目標端點是否可存取
授權
MIT