重要前提
安装AI Skills的关键前提是:必须科学上网,且开启TUN模式,这一点至关重要,直接决定安装能否顺利完成,在此郑重提醒三遍:科学上网,科学上网,科学上网。查看完整安装教程 →
sap-api-style by secondsky/sap-skills
npx skills add https://github.com/secondsky/sap-skills --skill sap-api-style此技能提供了根据官方 SAP API 风格指南标准记录 SAP API 的全面指导。它涵盖了 SAP 生态系统中使用的所有主要 API 类型和文档方法。
文档来源 : https://github.com/SAP-docs/api-style-guide (已提取 76 个文件)
最后验证日期 : 2025-11-21
在以下情况下使用此技能:
广告位招租
在这里展示您的产品或服务
触达数万 AI 开发者,精准高效
REST/OData API
├─ 自动生成 (OpenAPI/Swagger)?
│ └─ references/rest-odata-openapi-guide.md
│ • OpenAPI 规范标准
│ • 包、API、操作描述
│ • 参数、响应、组件
│ • SAP API Business Hub 要求
│
└─ 手动编写?
└─ references/manual-templates-guide.md
• REST 模板 (2级: 概述 → 方法)
• OData 模板 (3级: 服务 → 资源 → 操作)
• 完整的字段要求
• templates/ 目录中的即用型文件
Native Library API
├─ Java → references/java-javascript-dotnet-guide.md
├─ JavaScript → references/java-javascript-dotnet-guide.md
├─ .NET (C#) → references/java-javascript-dotnet-guide.md
└─ C/C++ → references/java-javascript-dotnet-guide.md
• 文档注释结构
• 语言特定标签
• 类、方法、枚举的模板
• 完整的代码示例
命名
└─ references/naming-conventions.md
• REST/OData 命名 (资源、参数、URI)
• 原生库命名 (类、方法、常量)
• 常见错误与避免方法
编写描述
└─ references/rest-odata-openapi-guide.md
• 包描述
• API 详细信息 (info 对象)
• 操作、参数、响应
质量保证
└─ references/quality-processes.md
• 完整的 API 质量检查清单
• 审查工作流
• 开发团队指南
弃用 API
└─ references/deprecation-policy.md
• 生命周期状态 (beta, active, deprecated, decommissioned)
• 时间线要求 (12+ 个月支持)
• 必需的元数据 (x-sap-stateInfo)
开发者指南
└─ references/developer-guides.md
• 结构指南
• 内容选择
• 代码示例标准
所有 SAP API 文档都遵循一致的约定:
文档按层次结构组织:
所有文档必须:
| 元素 | 限制 | 用例 |
|---|---|---|
| API 标题 | 80 | OpenAPI 中的 info.title |
| API 简短文本 | 180 | x-sap-shortText |
| 包简短描述 | 250 | 包磁贴描述 |
| 操作摘要 | 255 | 操作摘要行 |
| 描述 | 1024 | 通用描述 |
通用规则 (所有 API 类型):
完整的语言特定规则请参见 references/naming-conventions.md。
Java/JavaScript :
@param <name> <description> - 参数文档@return <description> - 返回值@throws <class> <description> - 异常@deprecated <description> - 弃用通知.NET :
<summary> - 简要描述<param name=""> - 参数<returns> - 返回值<exception cref=""> - 异常完整的标签参考请参见 references/java-javascript-dotnet-guide.md。
| 状态 | 定义 | 支持 | 必需元数据 |
|---|---|---|---|
| Beta | 预生产测试 | 无保证 | state: beta |
| Active | 生产就绪 (默认) | 完全支持 | 可选 |
| Deprecated | 已被后继者取代 | 12+ 个月 | state, deprecationDate, successorApi |
| Decommissioned | 完全停用 | 无 | 文档移除 |
完整的时间线和流程要求请参见 references/deprecation-policy.md。
templates/ 目录中的即用型模板:
所有模板包括:
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 行)
完整的术语定义 (API, OData, OpenAPI 等)
外部资源链接 (标准、工具、SAP 资源)
快速参考表
工具文档链接
内容提取和组织跟踪
来自 SAP 文档的源文件映射
整合和改编说明
此技能包含全面的文档和模板,旨在实现最佳使用:
references/)templates/)总计:2,343 行即用型模板
确定您要记录的是 REST、OData、Java、JavaScript、.NET 还是 C/C++ API。
自动生成 : 在源代码中编写文档注释 → 使用适当的标签 → 提交审查
手动 : 从 templates/ 中选择模板 → 自定义 [占位符] → 遵循层次结构 → 使用检查清单验证
查阅相应的参考文件:
naming-conventions.mdrest-odata-openapi-guide.md 或 java-javascript-dotnet-guide.mdquality-processes.mddeprecation-policy.md发布前:
quality-processes.md) 进行审查naming-conventions.md)命名 :
描述 :
文档 :
完整的反模式和修复方法请参见各个参考文件。
源版本 : SAP API 风格指南 2025.01 (针对提交 902247f 验证)
近期变更 :
更新此技能 :
建议每季度审查 : 每 3 个月检查一次更新
下次审查 : 2026-02-27
技能版本 : 1.1.0 最后更新 : 2025-11-27 许可证 : GPL-3.0 维护者 : SAP Skills Team | https://github.com/secondsky/sap-skills
每周安装数
62
仓库
GitHub 星标数
167
首次出现
Jan 23, 2026
安全审计
安装于
gemini-cli56
opencode54
codex54
github-copilot54
kimi-cli50
amp50
This skill provides comprehensive guidance for documenting SAP APIs according to official SAP API Style Guide standards. It covers all major API types and documentation approaches used across the SAP ecosystem.
Documentation Source : https://github.com/SAP-docs/api-style-guide (76 files extracted)
Last Verified : 2025-11-21
Use this skill when:
REST/OData API
├─ Auto-generated (OpenAPI/Swagger)?
│ └─ references/rest-odata-openapi-guide.md
│ • OpenAPI specification standards
│ • Package, API, operation descriptions
│ • Parameters, responses, components
│ • SAP API Business Hub requirements
│
└─ Manually written?
└─ references/manual-templates-guide.md
• REST templates (2-level: overview → method)
• OData templates (3-level: service → resource → operation)
• Complete field requirements
• templates/ directory for ready-to-use files
Native Library API
├─ Java → references/java-javascript-dotnet-guide.md
├─ JavaScript → references/java-javascript-dotnet-guide.md
├─ .NET (C#) → references/java-javascript-dotnet-guide.md
└─ C/C++ → references/java-javascript-dotnet-guide.md
• Documentation comments structure
• Language-specific tags
• Templates for classes, methods, enums
• Complete code examples
Naming
└─ references/naming-conventions.md
• REST/OData naming (resources, parameters, URIs)
• Native library naming (classes, methods, constants)
• Common mistakes to avoid
Writing Descriptions
└─ references/rest-odata-openapi-guide.md
• Package descriptions
• API details (info object)
• Operations, parameters, responses
Quality Assurance
└─ references/quality-processes.md
• Complete API Quality Checklist
• Review workflows
• Development team guidelines
Deprecating APIs
└─ references/deprecation-policy.md
• Lifecycle states (beta, active, deprecated, decommissioned)
• Timeline requirements (12+ months support)
• Required metadata (x-sap-stateInfo)
Developer Guides
└─ references/developer-guides.md
• Structure guidelines
• Content selection
• Code sample standards
All SAP API documentation follows consistent conventions:
| API Type | Standard | Tool | Documentation |
|---|---|---|---|
| REST | OpenAPI 3.0.3 | Swagger | Spec |
| OData | v4.01, v3.0, v2.0 | Various | OData.org |
| Java | Javadoc | javadoc | Oracle |
| JavaScript | JSDoc 3 | jsdoc | JSDoc.app |
| .NET | XML Comments | DocFX | Microsoft |
| C/C++ | Doxygen |
Documentation organized hierarchically:
All documentation must:
| Element | Limit | Use Case |
|---|---|---|
| API Title | 80 | info.title in OpenAPI |
| API Short Text | 180 | x-sap-shortText |
| Package Short Desc | 250 | Package tile description |
| Operation Summary | 255 | Operation summary line |
| Description | 1024 | General descriptions |
General Rules (all API types):
See references/naming-conventions.md for complete language-specific rules.
Java/JavaScript :
@param <name> <description> - Parameter documentation@return <description> - Return value@throws <class> <description> - Exception@deprecated <description> - Deprecation notice.NET :
<summary> - Brief description<param name=""> - Parameter<returns> - Return value<exception cref=""> - ExceptionSee references/java-javascript-dotnet-guide.md for complete tag reference.
| State | Definition | Support | Metadata Required |
|---|---|---|---|
| Beta | Pre-production testing | No guarantees | state: beta |
| Active | Production-ready (default) | Full support | Optional |
| Deprecated | Replaced by successor | 12+ months | state, deprecationDate, successorApi |
| Decommissioned |
See references/deprecation-policy.md for complete timeline and process requirements.
Ready-to-use templates in templates/ directory:
All templates include:
rest-odata-openapi-guide.md (2,800 lines)
manual-templates-guide.md (2,765 lines)
naming-conventions.md (2,059 lines)
quality-processes.md (1,774 lines)
java-javascript-dotnet-guide.md (1,517 lines)
This skill includes comprehensive documentation and templates organized for optimal use:
references/)templates/)Total: 2,343 lines of ready-to-use templates
Determine if you're documenting REST, OData, Java, JavaScript, .NET, or C/C++ API.
Auto-Generated : Write documentation comments in source code → Use appropriate tags → Submit for review
Manual : Select template from templates/ → Customize [placeholders] → Follow hierarchy → Validate with checklist
Consult appropriate reference file:
naming-conventions.mdrest-odata-openapi-guide.md or java-javascript-dotnet-guide.mdquality-processes.mddeprecation-policy.mdBefore publishing:
quality-processes.md)naming-conventions.md)Naming :
Descriptions :
Documentation :
See individual reference files for complete anti-patterns and fixes.
Source Version : SAP API Style Guide 2025.01 (verified against commit 902247f)
Recent Changes :
To Update This Skill :
Quarterly Review Recommended : Check for updates every 3 months
Next Review : 2026-02-27
Skill Version : 1.1.0 Last Updated : 2025-11-27 License : GPL-3.0 Maintainer : SAP Skills Team | https://github.com/secondsky/sap-skills
Weekly Installs
62
Repository
GitHub Stars
167
First Seen
Jan 23, 2026
Security Audits
Gen Agent Trust HubPassSocketPassSnykPass
Installed on
gemini-cli56
opencode54
codex54
github-copilot54
kimi-cli50
amp50
lark-cli 共享规则:飞书资源操作指南与权限配置详解
48,600 周安装
Sanity内容建模最佳实践:结构化内容设计原则与无头CMS指南
1,400 周安装
Chrome CDP 命令行工具:轻量级浏览器自动化,支持截图、执行JS、无障碍快照
1,300 周安装
template-skill 技能模板:快速构建AI技能,含触发词、输入输出与工作流
1,300 周安装
TanStack Start 全栈开发:基于 Cloudflare 的 React 19 + D1 数据库应用构建指南
1,300 周安装
Doublecheck AI 内容验证工具 - GitHub Copilot 三层事实核查流程,自动识别幻觉风险
1,400 周安装
Sentry问题修复指南:利用AI分析生产环境错误并自动修复
1,300 周安装
| doxygen |
| Doxygen.nl |
| Fully retired |
| None |
| Document removal |
developer-guides.md (704 lines)
deprecation-policy.md (664 lines)
glossary-resources.md (472 lines)
Complete terminology definitions (API, OData, OpenAPI, etc.)
External resource links (standards, tools, SAP resources)
Quick reference tables
Tool documentation links
Content extraction and organization tracking
Source file mapping from SAP documentation
Consolidation and adaptation notes