---

名称：typespec-sdk-generator 描述：基于 Microsoft TypeSpec 的 API 与 SDK 生成 允许使用的工具：

• 读取
• 写入
• 编辑
• 全局匹配
• 文本搜索
• Bash

---

TypeSpec SDK 生成器技能

概述

此技能利用 Microsoft TypeSpec（原名 Cadl）来设计 API，并遵循 Azure SDK 指南生成多语言 SDK。TypeSpec 提供了一种简洁、类型安全的 API 定义语言。

能力

• 使用 TypeSpec 语言设计 API
• 生成多语言 SDK（TypeScript、Python、Java、C#、Go）
• 输出 OpenAPI 及其他规范格式
• 自动应用 Azure SDK 风格指南
• 实现装饰器以提供丰富的 API 语义
• 支持版本控制与弃用模式
• 生成强类型客户端

目标流程

• SDK 代码生成流水线
• API 设计规范
• 多语言 SDK 策略

集成点

• TypeSpec 编译器与输出器
• 用于 SDK 生成的 AutoRest
• Azure SDK 代码生成流水线
• OpenAPI 输出器
• 自定义输出器开发

输入要求

• TypeSpec 模型文件 (.tsp)
• 每个目标的输出器配置
• 版本控制要求
• 风格指南偏好
• 自定义装饰器（如有）

输出产物

• 每种语言的生成 SDK 源代码
• OpenAPI 规范
• JSON 模式
• API 文档
• 客户端库包

使用示例

技能：
  名称：typespec-sdk-generator
  上下文：
    模型目录：./typespec
    输出器：
      - "@azure-tools/typespec-ts"
      - "@azure-tools/typespec-python"
      - "@typespec/openapi3"
    应用Azure指南：true
    API版本："2024-01-01"

最佳实践

1. 使用命名空间组织 API 结构
2. 利用装饰器进行文档化和行为定义
3. 使用 @versioned 实现适当的版本控制
4. 使用模板实现可重用模式
5. 定义清晰的模型继承层次结构
6. 应用 Azure SDK 指南以确保一致性