Sap Api Style
- Updated May 19, 2026
- AndreaFusar/https-github.com-secondsky-sap-skills
sap-api-style is an agent skill that documents and reviews SAP-style REST, OData, and multi-language APIs against Business Hub-quality standards.
About
sap-api-style is an agent skill that encodes the SAP API Style Guide for developers and small teams publishing integrations or B2B APIs that must read like SAP API Business Hub material. Use it when drafting new endpoint docs, OpenAPI descriptions, or inline comments for REST and OData services, or when auditing existing packages before partner review. The skill walks through naming, structured documentation comments across Java, JavaScript,.NET, and native stacks, OpenAPI and Swagger patterns, deprecation policies, and manual templates so agents do not invent ad-hoc doc shapes. It also supports review passes against documented quality checklists rather than subjective tone edits. Best fit when you already have an API shape but need standards-grade prose and metadata; less useful for greenfield API design without SAP-style constraints. Pair with your OpenAPI generator or backend skill, then run this before publish or PR review.
- REST, OData, Java, JavaScript, .NET, and C/C++ documentation conventions in one style guide
- OpenAPI specs, x-sap-stateInfo, EDM, and SAP API Business Hub alignment
- Quality checklists and deprecation policies for review-ready API surfaces
- Naming conventions and documentation tags (Javadoc, JSDoc, XML) for enterprise APIs
Sap Api Style by the numbers
- Data as of Jul 7, 2026 (Skillselion catalog sync)
/plugin marketplace add AndreaFusar/https-github.com-secondsky-sap-skills/plugin install sap-api-style@sap-skillsAdd your badge
Show developers this skill is listed on Skillselion. Paste this into your README.
| Last updated | May 19, 2026 |
|---|---|
| Repository | AndreaFusar/https-github.com-secondsky-sap-skills ↗ |
What it does
Document or review SAP-aligned REST, OData, and language-specific APIs with naming rules, OpenAPI, deprecation, and hub-quality checklists.
Who is it for?
Best when you're shipping OData/REST integrations, extensions, or published APIs that must match SAP API Style Guide and hub conventions.
Skip if: Skip if you're documenting non-SAP public APIs with no OData or SAP metadata requirements, or projects that only need a quick README without OpenAPI rigor.
When should I use this skill?
Creating or reviewing API documentation for REST, OData, Java, JavaScript, .NET, or C/C++ APIs against SAP API Style Guide standards.
What you get
After the skill runs, API docs and OpenAPI artifacts follow SAP naming, comment, deprecation, and checklist patterns ready for review or Business Hub publication.
- Style-aligned API documentation comments and OpenAPI sections
- Review notes against SAP API quality and deprecation checklist items
By the numbers
- Covers REST, OData, Java, JavaScript, .NET, and C/C++ API documentation surfaces
- Includes API quality checklists and deprecation policy guidance
- Skill package version 2.2.0 in source metadata
Files
This skill provides comprehensive guidance for documenting SAP APIs following the SAP API Style Guide standards. It should be used when creating or reviewing API documentation for REST, OData, Java, JavaScript, .NET, or C/C++ APIs. The skill covers naming conventions, documentation comments, OpenAPI specifications, quality checklists, deprecation policies, and manual documentation templates. It ensures consistency with SAP API Business Hub standards and industry best practices. Keywords: SAP API, REST, OData, OpenAPI, Swagger, Javadoc, JSDoc, XML documentation, API Business Hub, API naming, API deprecation, x-sap-stateInfo, Entity Data Model, EDM, documentation tags, API quality, API templates
sap-api-style
Source: ./plugins/sap-api-style
{ "name": "sap-api-style", "source": "./plugins/sap-api-style", "license": "GPL-3.0", "version": "2.2.0", "category": "tooling", "keywords": [ "api", "automation", "cli", "development", "java", "javascript", "odata", "productivity", "rest", "sap", "sap-api-style", "style", "tools", "xml" ], "description": "This skill provides comprehensive guidance for documenting SAP APIs following the SAP API Style Guide standards. It should be used when creating or reviewing API documentation for REST, OData, Java, JavaScript, .NET, or C/C++ APIs. The skill covers naming conventions, documentation comments, OpenAPI specifications, quality checklists, deprecation policies, and manual documentation templates. It ensures consistency with SAP API Business Hub standards and industry best practices. Keywords: SAP API, REST, OData, OpenAPI, Swagger, Javadoc, JSDoc, XML documentation, API Business Hub, API naming, API deprecation, x-sap-stateInfo, Entity Data Model, EDM, documentation tags, API quality, API templates" }
Related skills
Lark MarkdownInstantly turn any markdown file into clean, formatted Lark/Figma-compatible documents without manual reformatting.488k
Lark DocCreate, read, update, summarize, rewrite and manage Feishu/Lark cloud documents directly from agent workflows.401k16.1kLark WikiCreate, organize, query, and manage documents, spaces, and members inside Lark (Feishu) knowledge bases directly from AI agent workflows.397k16.1k
Domain ModelingBuild and sharpen a project's domain model: pin down domain terminology in a glossary and record architectural decisions as ADRs.318k202k
Opensource Guide CoachGet expert, attribution-safe guidance on launching and sustaining an open-source project.270k71Readme I18nMaintain consistent, updatable language selector blocks across every README variant in a multilingual repository.270k71How it compares
Use as a standards checker and doc template pack—not a generic OpenAPI generator or MCP server.
FAQ
Who is sap-api-style for?
Developers and small teams writing or reviewing SAP API Style Guide documentation for REST, OData, and Java, JavaScript,.NET, or C/C++ surfaces.
When should I use sap-api-style?
During Build when authoring API docs and OpenAPI specs; during Ship when reviewing API documentation before release or hub upload.
Is sap-api-style safe to install?
It is procedural documentation guidance; review the Security Audits panel on this Prism page before installing from any third-party skills source.