Cadl Ranch Specs
This package contains all the scenarios that should be supported by a client generator.
Development
- FOLLOW THE MONOREPO INSTRUCTION to get the environment setup.
- Scenarios should be in
./http folder
Writing scenarios
Docs on writing scenarios specs
Writing mockapis
Docs on writing mock apis
Validate the scenarios are valid
pnpm run validate-scenarios
Validate the mock apis are valid
pnpm run validate-mock-apis
Start mock api server
This will start the server using the mock apis. When writing a mock api use this command to start the server.
pnpm run serve
关于 @azure-tools/cadl-ranch-specs 的常见问题
@azure-tools/cadl-ranch-specs 是什么？
Cadl scenarios and mock apis注意：该包已被作者标记为弃用——Package moved to @typespec/http-specs
如何安装 @azure-tools/cadl-ranch-specs？
在项目目录运行 npm install @azure-tools/cadl-ranch-specs，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@typespec/xml（~0.63.0）、@typespec/http（~0.63.0）、@typespec/rest（~0.63.0）、@typespec/compiler（~0.63.0）、@typespec/versioning（~0.63.0）、@azure-tools/cadl-ranch-expect（~0.15.7）、@azure-tools/typespec-azure-core（~0.49.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。
@azure-tools/cadl-ranch-specs 支持 TypeScript 吗？
该包的 package.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/azure-tools__cadl-ranch-specs 是否存在。
@azure-tools/cadl-ranch-specs 支持 ESM 还是 CommonJS？
以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module，更早的版本需要改用动态 import()。
@azure-tools/cadl-ranch-specs 需要什么版本的 Node.js？
package.json 的 engines 字段要求 Node.js >=16.0.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。
@azure-tools/cadl-ranch-specs 可以商用吗？
@azure-tools/cadl-ranch-specs 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。
@azure-tools/cadl-ranch-specs 的下载量有多少？
根据 npm 官方下载统计，@azure-tools/cadl-ranch-specs 在 2026/10/08 – 2026/11/06 这 30 天内被下载 1,901 次，日均约 63 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。
@azure-tools/cadl-ranch-specs 还在维护吗？
最新版本 0.39.6 发布于 2024/12/12（1.9 年前）；至今共发布 153 个版本，其中过去 12 个月发布了 0 个；首次发布于 2022/07/29。作者已将其标记为弃用，新项目建议寻找替代方案。