用途:为 Salesforce DX 项目提供全部 604 种 Metadata API 类型的文档,帮助创建、理解和修改元数据 XML 文件(如 .object-meta.xml、.flow-meta.xml)。
主要能力:每种类型以 data/metadata_api/ 下的 JSON 文件存储,包含 title、description、fields、sub_types、file_information、directory_location、wsdl_segment、declarative_metadata_sample_definition 等分区,提供字段定义与类型、必填与可选字段、WSDL 模式、示例 XML、文件命名约定和 SFDX 目录位置。
使用方式:按需只加载所需分区,避免整文件读取。字段定义只取 fields,了解用途只取 description,XML 示例只取 declarative_metadata_sample_definition;默认跳过 wsdl_segment、file_information、directory_location。可用 jq 或程序化 JSON 解析提取分区,示例见 examples/python_section_loading.py、examples/javascript_section_loading.js、examples/bash_section_loading.sh。生成 XML 时须包含 XML 声明与命名空间 http://soap.sforce.com/2006/04/metadata,根元素与类型匹配,部署前可用 sf project deploy validate 校验。
适用场景:编写或修改元数据 XML、核对字段名与类型、生成正确 XML 结构、按需组合相关类型(如 CustomObject + CustomField + ValidationRule)。
限制:JSON 文件为 PascalCase 且区分大小写;required: true 未必覆盖实际编写所需字段,需对照示例;类型名可能与 Enterprise/Data API 或 Tooling API 重名,需按上下文区分;未提供收费、价格或平台支持信息。