用途
该技能用于按照 SAP API Style Guide 官方标准编写和审查 SAP API 文档，覆盖 SAP 生态系统中使用的主要 API 类型和文档方式。文档来源为 https://github.com/SAP-docs/api-style-guide（提取 76 个文件）。
主要能力
- 为 REST、OData、Java、JavaScript、.NET、C/C++ API 创建 API 文档。
- 为 SAP API Business Hub 编写 OpenAPI 规范。
- 审查 API 名称是否符合 SAP 命名约定。
- 按规范格式记录 API 参数、响应和操作。
- 使用 SAP 模板创建手动 API 文档。
- 在源代码中编写文档注释（Javadoc、JSDoc、XML 注释）。
- 按 SAP 生命周期策略实施 API 弃用。
- 编写开发者指南或服务文档。
- 对 API 文档进行质量检查。
- 将 API 发布到 SAP API Business Hub。
使用方式
技能提供快速决策树，按 API 类型和任务路由到对应参考文件：
- REST/OData 自动生成（OpenAPI/Swagger）：references/rest-odata-openapi-guide.md
- REST/OData 手动编写：references/manual-templates-guide.md
- Java、JavaScript、.NET、C/C++ 原生库 API：references/java-javascript-dotnet-guide.md
- 命名：references/naming-conventions.md
- 质量保证：references/quality-processes.md
- API 弃用：references/deprecation-policy.md
- 开发者指南：references/developer-guides.md
使用步骤：先识别 API 类型，再选择自动生成或手动模板方式，应用相应标准，进行质量检查，最后发布。
模板与参考文件
templates/ 目录提供即用模板：REST API 模板（2 级：概览、方法）、OData API 模板（3 级：服务、资源、操作）。所有模板包含使用说明、占位符、完整章节结构、示例和内联指导。
references/ 目录包含 9 个参考文件（共约 10,861 行），包括 rest-odata-openapi-guide.md（约 2,800 行）、manual-templates-guide.md（约 2,765 行）、naming-conventions.md（约 2,059 行）、quality-processes.md（约 1,774 行）、java-javascript-dotnet-guide.md（约 1,517 行）、developer-guides.md（约 704 行）、deprecation-policy.md（约 664 行）、glossary-resources.md（约 472 行）等。
核心原则
- 一致性：命名、结构、格式、语言（美式英语）在 SAP API 文档中保持一致。
- 按 API 类型采用不同标准：REST 用 OpenAPI 3.0.3，OData 用 v4.01/v3.0/v2.0，Java 用 Javadoc，JavaScript 用 JSDoc 3，.NET 用 XML 注释，C/C++ 用 Doxygen。
- 渐进式披露：高层概览提供上下文，详细参考覆盖具体 API，示例和模板展示实际用法。
- 质量标准：需经 User Assistance（UA）开发者审查，命名与术语一致，参数和响应描述完整，示例不含敏感数据，代码示例可运行，链接准确。
适用场景
适用于 SAP 生态内 API 文档的创建、审查、命名检查、OpenAPI 规范编写、源码注释编写、弃用管理、开发者指南编写和 API Business Hub 发布等任务。
限制
资料未提供该技能的具体安装命令、运行环境要求、收费或价格信息。技能版本为 2.4.1，许可证 GPL-3.0，维护者为 Eduard Jiglau。源版本为 SAP API Style Guide 2025.01（对照提交 902247f 验证）。