Skip to main content
affpapa.org
RU EN
skill CX Codex

sap-api-style — Claude Code skill: what it does, how to install

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.

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓ 
npx skills add secondsky/sap-skills --skill sap-api-style -a claude-code
Open on GitHub

What sap-api-style 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.

What it helps with

  • 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 for the agent

  • 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

How to install sap-api-style

1Skills CLI (Vercel)

npx skills add secondsky/sap-skills --skill sap-api-style -a claude-code

2Manually: put the files in place

~/.claude/skills/sap-api-style/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/sap-api-style/

Step by step, with commands for each platform: How to install skills in Claude Code: five ways

Questions about sap-api-style

How to install sap-api-style in Claude Code?

Run npx skills add secondsky/sap-skills --skill sap-api-style -a claude-code in your terminal.

What is the sap-api-style skill?

It provides formatting standards, templates, and naming rules for documenting SAP REST, OData, and native APIs.

What are the lifecycle rules for deprecated APIs in this guide?

The guidelines require tracking lifecycle states with x-sap-stateInfo metadata and supporting deprecated endpoints for at least 12 months.

Similar skills

All skills for Backend and APIs →
sap-fiori-add-visual-filter sap-fiori-tools Adds chart-based visual filters to SAP Fiori Elements filter bars and value help dialogs using CAP or ABAP RAP. Configures CDS aggregation annotations and UI charts. CX Codex +1 601installs sap-fiori-app-development sap-fiori-tools A skill that tells the agent how to build SAP Fiori Elements apps: List Report, Object Page, Worklist, wired to CAP or an OData service. CX Codex +1 595installs api-reference-documentation aj-geddes A skill that walks the agent through writing API reference docs: endpoints, auth, request and response examples, OpenAPI specs. CX Codex +1 494installs api-design-patterns agent-skills A skill with 38 REST API rules covering resources, errors, security, pagination and versioning. Useful when an agent writes or reviews endpoints. CX Codex +1 929installs api-documenter zhaono1 A skill for writing REST and GraphQL API documentation as OpenAPI/Swagger specs. Useful when scattered endpoints need to become one readable file. CX Codex +1 717installs api-designer VoltAgent Community Designs REST and GraphQL API architectures, creates OpenAPI 3.1 specifications, and plans authentication. Useful when building new endpoints or refactoring old APIs. 756installs

From the same set24

sap-btp-connectivity Configures SAP BTP Destination Service, Cloud Connector, and Kubernetes proxies for hybrid networking. Useful when solving 405, 407, and 503 errors. CX Codex +1 943installs sap-abap-cds Provides reference data and syntax patterns for SAP ABAP Core Data Services from 7.40 SP8 up to ABAP Cloud. Useful when drafting CDS view entities, associations, and DCL roles. CX Codex +1 939installs sap-btp-cloud-logging Guides SAP Cloud Logging setup on SAP BTP, from Cloud Foundry and Kyma ingestion to OpenSearch dashboards. CX Codex +1 851installs sapui5-cli Guides SAPUI5 and OpenUI5 work through the UI5 CLI: project setup, builds, dev server, ui5.yaml config. CX Codex +1 813installs sap-ai-core Guides development of machine learning and generative pipelines on SAP BTP. Useful when configuring model endpoints, grounding flows, or prompt filters. CX Codex +1 723installs sap-hana-cli This skill teaches your agent to drive hana-cli: inspect tables and views, run SQL, manage HDI containers, and export metadata to CDS, EDMX or OpenAPI. CX Codex +1 717installs sap-sqlscript A skill with SQLScript patterns for HANA procedures, functions, and AMDP methods. It helps an agent write database-layer code without hunting through SAP docs. CX Codex +1 711installs sapui5 A skill that helps AI agents build SAP UI5 apps: XML views, controllers, data binding, OData, Fiori Elements and tests. CX Codex +1 697installs

Project sponsors

Companies that keep this analytics open
Gold sponsor
Nutra.Club

Impressions, clicks and code copies — open statistics. We keep the numbers public for the same reason NeBlask itself is public. Become a sponsor