用途:在已有的 TypeSpec API 插件中为 Microsoft 365 Copilot 添加 RESTful 操作,包括 GET、POST、PATCH、DELETE,并配置路由、参数与自适应卡片。
主要能力:
- GET:支持列表、查询参数过滤(@query)、路径参数获取单条(@path),并可用 @card 绑定自适应卡片文件(如 appPackage/item-card.json)进行可视化。
- POST:用 @body 接收创建请求模型(如 CreateItemRequest),可加 @capabilities 确认卡片。
- PATCH:按 @path id 更新,@body 传 UpdateItemRequest,可加确认。
- DELETE:按 @path id 删除,可加确认,建议对破坏性操作加确认。
- 支持多查询参数、@header 头参数、自定义响应模型与错误响应模型(如 Item | ErrorResponse)。
- 提供完整 CRUD 示例:@service、@server、@actions 命名空间,模型含 @visibility(Lifecycle.Read)、@format("date-time")、联合类型枚举。
使用方式:在 TypeSpec 文件中用 @route、@get/@post/@patch/@delete 装饰操作,用 @query/@path/@body/@header 标注参数,用 @card 绑定卡片 JSON,用 @capabilities 配置确认。自适应卡片为 JSON 文件,含 type、$schema、version、body、actions 等字段。
适用场景:为 Copilot 插件暴露 REST 接口,让用户通过自然语言完成列表、查询、创建、更新、删除等操作。
限制与注意:资料未提供安装命令、收费或平台细节。常见问题包括参数未显示(检查 @query/@path/@body 装饰)、卡片不渲染(检查 @card 文件路径与 JSON 语法)、确认不出现(检查 @capabilities 格式)、模型属性缺失(检查 @visibility 或可写性)。