README.md
以下内容由 AI 翻译,如有问题请点此提交 issue 反馈
TypeSpec Azure 库
TypeSpec 是一种用于描述云 服务 API 并生成其他 API 描述语言、客户端和 服务代码、文档及其他资产的语言。
此仓库为作为 git 子模块引入的 TypeSpec 核心添加了通用的 Azure 专用 TypeSpec 库。
无需安装即可试用 TypeSpec
您可以在 Web 上试用 TypeSpec,无需安装任何内容。 TypeSpec Azure 服务 playground
先决条件
- 要使用这些库,请安装 Node.js(24 LTS 或更高版本),并确保
您可以在命令提示符中运行
node --version。 - 要开发此仓库,请安装并激活
mise。从仓库根目录,
运行
mise install以安装由mise.toml和mise.lock定义的开发工具。有关 完整的设置,请参阅 贡献指南。
入门
有关 TypeSpec 语言文档,请参阅 https://typespec.io/docs。
如果您是在 Azure 上工作的团队,请参阅 TypeSpec Azure 开发文档 https://azure.github.io/typespec-azure。您还应预安装 @azure-tools/typespec-azure-core 以定义 Azure 资源,以及 @azure-tools/typespec-autorest 以导出为 Swagger:
pnpm add @typespec/rest @typespec/openapi3 @azure-tools/typespec-azure-core @azure-tools/typespec-autorest
如果你计划使用 autorest 或任何 azure sdk 工具链来使用输出的 openapi,你应该使用 typespec-autorest,因为 openapi3 发射器不会包含任何 ms 扩展(pageable、lro、client name 等),因此会丢失信息。
构建流水线
有关在构建流水线中使用 TypeSpec 的信息 可在此处找到
包
| 名称 | 变更日志 | 最新版本 | 下一版本 |
|---|---|---|---|
| @azure-tools/typespec-autorest | 变更日志 | ||
| @azure-tools/typespec-azure-core | 变更日志 | ||
| @azure-tools/typespec-resource-manager | 变更日志 |
@next 版本的包是 main 分支上可用的最新版本。
包分层
本仓库中的主要包可以被视为一系列分层,它们针对特定场景逐步添加功能:
- @azure-tools/typespec-azure-core: 提供用于 Azure 服务建模的核心模型和接口
- @azure-tools/typespec-azure-resource-manager: 提供用于建模 Azure Resource Manager 服务的额外模型和接口