# sap-api-style

Guides developers in documenting REST, OData, and native code APIs using SAP API Style Guide rules. Useful when preparing specs for SAP API Business Hub.

- skill · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode · 785 installs · ★ 475
- Author: secondsky
- License: GPL-3.0 · policy=link-only · description only; the file stays with the author
- Source: https://github.com/secondsky/sap-skills/tree/HEAD/plugins/sap-api-style/skills/sap-api-style/SKILL.md
- Updated: 2026-10-21
- HTML: https://affpapa.org/en/nevibecode/skills/sap-api-style

## What it does

This skill integrates official SAP API Style Guide standards across REST, OData (v2.0, v3.0, v4.01), and native libraries in Java, JavaScript, .NET, and C/C++. It covers code documentation standards using Javadoc, JSDoc, XML comments, and Doxygen.

It provides naming conventions and structural templates. REST templates follow a two-level structure, while OData uses a three-level hierarchy. The guidelines enforce strict character limits: 80 characters for the API title, 180 for `x-sap-shortText`, and 255 for operation summaries. Deprecation workflows demand `x-sap-stateInfo` metadata along with a minimum 12-month support commitment. All texts must be written in American English.

## Install

### Claude Code (native platform)

1. **Skills CLI (Vercel)**
```bash
npx skills add secondsky/sap-skills --skill sap-api-style -a claude-code
```

2. **Manually: put the files in place**
- File: `~/.claude/skills/sap-api-style/SKILL.md` — Copy the whole skill folder; for one project use .claude/skills/sap-api-style/

### Codex

1. **Skills CLI (Vercel)**
```bash
npx skills add secondsky/sap-skills --skill sap-api-style -a codex
```

2. **Manually: put the files in place**
- File: `.agents/skills/sap-api-style/SKILL.md` — For all projects use ~/.agents/skills/

### Cursor

1. **Skills CLI (Vercel)**
```bash
npx skills add secondsky/sap-skills --skill sap-api-style -a cursor
```

2. **Manually: put the files in place**
- File: `.cursor/skills/sap-api-style/SKILL.md` — Cursor also reads .agents/skills/ and .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install secondsky/sap-skills sap-api-style
```

2. **Manually: put the files in place**
- File: `.github/skills/sap-api-style/SKILL.md`

### Gemini CLI

1. **Skills CLI (Vercel)**
```bash
npx skills add secondsky/sap-skills --skill sap-api-style -a gemini-cli
```

2. **Platform CLI**
```bash
gemini skills install https://github.com/secondsky/sap-skills --path plugins/sap-api-style/skills/sap-api-style
```

### Windsurf (Devin Desktop)

**Manually: put the files in place**
- File: `.devin/skills/sap-api-style/SKILL.md` — The legacy .windsurf/skills/ path still works

### OpenCode

**Skills CLI (Vercel)**
```bash
npx skills add secondsky/sap-skills --skill sap-api-style -a opencode
```

### Claude.ai

**Claude.ai**
- Zip the folder and upload it in Settings → Capabilities → Skills

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/secondsky/sap-skills/tree/HEAD/plugins/sap-api-style/skills/sap-api-style/SKILL.md

## When to use it
- format OpenAPI 3.0.3 specifications for SAP API Business Hub
- audit endpoint and parameter names against SAP naming conventions
- write standardized code comments using Javadoc or JSDoc
- document API deprecation using x-sap-stateInfo
- generate three-level documentation templates for OData services

## Example prompts
- Review this OpenAPI specification against sap-api-style guidelines
- Generate JSDoc comments for this JavaScript library following SAP standards
- Check if my OData resource names comply with SAP API style rules

## Similar
- [sap-fiori-add-visual-filter](https://affpapa.org/en/nevibecode/skills/sap-fiori-tools-sap-fiori-add-visual-filter.md) — skill · 601 installs
- [sap-fiori-app-development](https://affpapa.org/en/nevibecode/skills/sap-fiori-app-development.md) — skill · 595 installs
- [api-reference-documentation](https://affpapa.org/en/nevibecode/skills/api-reference-documentation.md) — skill · 494 installs
- [api-design-patterns](https://affpapa.org/en/nevibecode/skills/api-design-patterns.md) — skill · 929 installs
- [api-documenter](https://affpapa.org/en/nevibecode/skills/api-documenter.md) — skill · 717 installs
- [api-designer](https://affpapa.org/en/nevibecode/agents/api-designer.md) — subagent · 756 installs

From the same set: [secondsky/sap-skills](https://affpapa.org/en/nevibecode/by/secondsky/sap-skills.md) — 24 cards

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md