sap-api-style

Featured

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

Data & Documents 414 stars 113 forks Updated 4 days ago GPL-3.0

Install

View on GitHub

Quality Score: 90/100

Stars 20%
87
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# SAP API Style Guide ## Related Skills - **sap-cap-capire**: Use for OData service documentation, CAP API patterns, and service definition standards - **sap-fiori-tools**: Use for API consumption patterns, Fiori app integration, and OData best practices - **sap-abap**: Use when documenting ABAP APIs, implementing REST services, or following API design patterns - **sapui5**: Use for frontend API integration, OData consumption, and UI service patterns - **sap-btp-cloud-platform**: Use for BTP service API documentation and integration patterns ## Table of Contents 1. [Overview](#overview) 2. [When to Use This Skill](#when-to-use-this-skill) 3. [Quick Decision Tree](#quick-decision-tree) 4. [Core Principles](#core-principles) 5. [Quick Reference Tables](#quick-reference-tables) 6. [Templates Available](#templates-available) 7. [Reference Files](#reference-files) 8. [Instructions for Use](#instructions-for-use) 9. [Common Pitfalls to Avoid](#common-pitfalls-to-avoid) 10. [External Resources](#external-resources) 11. [Updates and Maintenance](#updates-and-maintenance) 12. [Common Issues](#common-issues) ## Overview 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](https://github.com/SAP-docs/api-style-guide) (76 files extracted) ## When to Use ...

Details

Author
secondsky
Repository
secondsky/sap-skills
Created
9 months ago
Last Updated
4 days ago
Language
JavaScript
License
GPL-3.0

Similar Skills

Semantically similar based on skill content — not just same category

API & Backend Listed

sap-api-style

SAP API documentation standards — OData API documentation guidelines, REST API style guide, OpenAPI/Swagger specs for SAP services, API naming conventions, SAP API Business Hub documentation requirements. Use when documenting SAP APIs, creating OpenAPI specs for SAP services, or reviewing API documentation against SAP standards.

0 Updated 3 weeks ago
williamcorrea23
AI & Automation Featured

sap-ai-core

Guides development with SAP AI Core and SAP AI Launchpad for enterprise AI/ML workloads on SAP BTP. Use when: deploying generative AI models, building orchestration workflows with templating/filtering/grounding, implementing RAG with vector databases, managing ML training pipelines with Argo Workflows, configuring content filtering and data masking for PII protection, using the Generative AI Hub for prompt experimentation, managing prompt templates via the Prompt Registry, or integrating AI capabilities into SAP applications. Covers service plans (Free/Standard/Extended), model providers (Azure OpenAI, AWS Bedrock, GCP Vertex AI, Mistral, IBM, Perplexity), orchestration modules, embeddings, tool calling, and structured outputs.

414 Updated 4 days ago
secondsky
API & Backend Featured

sap-api-policy

Evidence-based assessment of whether an SAP API/interface usage scenario aligns with the SAP API Policy (v.4.2026a). Use whenever someone asks whether a way of calling SAP is allowed/compliant — e.g. Published API vs internal/private/"confidential" API status, "Documented Use", whether a third-party tool / iPaaS / middleware / RPA bot / AI agent / MCP server may call SAP APIs, agentic or generative-AI access to SAP, bulk data extraction or replication into a lake/warehouse, custom Z/Y OData or RFC/BAPI wrappers and Clean Core, ADT/developer-tooling boundaries, ODP-RFC and other "not permitted" interfaces, partner Integration Certification, or RISE integration remediation. Trigger even when the policy is not named, e.g. "are we allowed to…", "is it compliant to…", "can we connect X to SAP…", "will this break under the new API policy". Produces a sourced technical assessment with a confidence level — explicitly NOT legal advice and NOT a final SAP compliance decision.

414 Updated 4 days ago
secondsky