What API types does this skill support?

The skill provides guidance for REST, OData, Java, JavaScript, .NET, and C/C++ APIs.

Does it include templates for manual documentation?

Yes, it provides ready-to-use Markdown templates for REST and OData services, covering everything from high-level overviews to specific operation details.

Does this skill help with SAP API Business Hub publishing?

Yes, it includes the specific formatting, metadata requirements (like x-sap-shortText), and templates needed for official SAP publication.

Can it help me rename my API resources?

Absolutely. It contains detailed naming conventions for resources, parameters, and URIs to ensure they match SAP ecosystem standards.

SAP API Style Guide

Name: SAP API Style Guide
Author: secondsky

bysecondsky

•

API Development

Provides comprehensive guidance and production-ready templates for documenting SAP APIs according to official SAP Style Guide standards.

This skill equips developers and technical writers with the authoritative standards for documenting SAP APIs, covering REST, OData, and various native library languages. It streamlines the creation of OpenAPI specifications, ensures consistent naming conventions, and provides ready-to-use templates for SAP API Business Hub integration. By following these production-ready patterns, teams can ensure their API documentation meets SAP's high-quality requirements, follows correct deprecation lifecycles, and aligns perfectly with the broader SAP ecosystem's best practices.

Key Features

01Standardized templates for REST and OData documentation hierarchies

02Detailed API lifecycle management and deprecation policy guidance

032 GitHub stars

04Automated guidance for official SAP API naming conventions

05Comprehensive OpenAPI specification and Swagger implementation standards

06Quality assurance checklists for SAP API Business Hub compliance

Use Cases

01Reviewing existing API specifications for compliance with SAP standards

02Designing and documenting RESTful or OData services for SAP BTP

03Preparing API documentation for publication on the SAP API Business Hub

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add secondsky/sap-skills sap-api-style

For use in Claude.ai and ChatGPT

Download Skill