skills.rest
dherbe-digital
dherbe-digitalCOMMUNITY
Explore all skills by this author →
GitHub

sap-api-style

Align SAP API documentation with the SAP API Style Guide.

Updated Jan 27, 2026
Search Tags:#documentation#OpenAPI#naming-conventions#progressive-disclosure#UA-review#API-quality#SAP-style-guide
One-click install
npx skills add https://github.com/dherbe-digital/nova-skills-collection --skill sap-api-style
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: sap-api-style
Source: https://github.com/dherbe-digital/nova-skills-collection/tree/main/plugins/sap/development-tools/sap-api-style/skills/sap-api-style
Command: npx skills add https://github.com/dherbe-digital/nova-skills-collection --skill sap-api-style

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

The SAP API Style Guide skill consolidates official standards into a ready-to-use reference, helping teams document APIs consistently and align with SAP API Business Hub requirements.

Core Features & Use Cases

  • Standards Consolidation: Centralized guidance covering REST, OData, OpenAPI, JavaDoc/JSDoc, XML comments, and manual templates.
  • Compliance & Consistency: Ensures naming conventions, documentation tags, templates, and QA checks are followed.
  • Use Case: When drafting an API reference or developer guide, apply this skill to generate standards-aligned content and validate against the style guide.

Quick Start

Use this skill to produce a ready-to-use outline for your SAP API documentation and incorporate it into your build or editor workflow.

Frequently Asked Questions about sap-api-style

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I align my SAP API documentation with the official style guide?▼

To align SAP API documentation with the style guide, apply centralized standards covering naming conventions, tags, templates, and QA checklists for REST, OData, and native language APIs.

What is progressive disclosure in SAP API documentation?▼

Progressive disclosure in SAP API documentation is a standard ensuring compliance by structuring information so users see essential details first, managed through specific templates and QA checks.

How do I apply SAP naming conventions to OpenAPI and OData definitions?▼

Apply SAP naming conventions to OpenAPI and OData definitions by using consolidated reference guidelines that validate documentation tags and structural templates against the SAP API Business Hub requirements.

Does the SAP API Style Guide cover native language API documentation like JavaDoc and JSDoc?▼

Yes, the SAP API Style Guide covers native language API documentation, providing specific standards and templates for JavaDoc, JSDoc, and XML comments alongside REST and OData specifications.

What's the best way to validate API documentation against SAP Business Hub requirements?▼

The best way to validate API documentation against SAP Business Hub requirements is to use a consolidated QA checklist ensuring naming conventions, license compliance, and progressive disclosure standards are met.

When do I need to use the SAP API Style Guide for my REST API project?▼

Use the SAP API Style Guide when drafting an API reference or developer guide to generate standards-aligned content, ensure license compliance, and validate consistency for editor workflows.

Related Skills

Explore More Content & Communication Skills→
hpsgdhpsgd

write-api-docs

Generate API reference documentation from code, OpenAPI specs, and endpoint implementations.

Official
Advanced
DayronDLRDayronDLR
3

verify

Automate quality checks for SAP CAP and Fiori projects.

Community
Advanced
ianyimiianyimi
1

Global Conventions

Enforce global coding conventions across codebases during linting, formatting, and reviews.

Community
Basic
DayronDLRDayronDLR
3

sap-api-style

Generate SAP API documentation from OpenAPI specifications using Python.

Community
Advanced