Does this skill support OData v2 and v4?

Yes, it provides comprehensive guidance and templates for OData v4.01, v3.0, and v2.0 services used in SAP environments.

How does it help with SAP API Business Hub publication?

It ensures your OpenAPI specifications meet SAP's specific metadata requirements, including character limits for titles and descriptions, and mandatory vendor extensions.

Are there ready-to-use documentation templates included?

Yes, it includes 2-level templates for REST (Overview/Method) and 3-level templates for OData (Service/Resource/Operation) documentation.

Does it cover API deprecation policies?

Yes, it includes the official SAP deprecation policy, outlining required timelines, support guarantees, and mandatory metadata for decommissioned services.

Can I use this for native library APIs like Java or .NET?

Absolutely. The skill includes specific guides for Java (Javadoc), JavaScript (JSDoc), .NET (XML comments), and C/C++ (Doxygen) following SAP standards.

SAP API Style & Documentation

Name: SAP API Style & Documentation
Author: secondsky

bysecondsky

•

API Development

Standardizes SAP API documentation and design patterns according to official SAP style guides for REST, OData, and native library interfaces.

About

This skill provides developer-focused guidance and ready-to-use templates for creating production-grade SAP API documentation. It facilitates the application of official SAP naming conventions, quality checklists, and OpenAPI specifications across the entire SAP ecosystem, including BTP, CAP, and Fiori. Whether you are documenting REST endpoints, OData services, or native language libraries like Java and .NET, this skill ensures consistency with the SAP API Business Hub standards while managing complex tasks like deprecation policies and character limit compliance.

Key Features

Provides standardized templates for REST and OData documentation hierarchy levels.
11 GitHub stars
Generates OpenAPI 3.0.3 and OData specifications compliant with SAP Business Hub.
Implements SAP-specific deprecation policies and lifecycle state metadata (x-sap-stateInfo).
Guides source code documentation for Java (Javadoc), JS (JSDoc), and .NET (XML).
Applies official SAP naming conventions for resources, parameters, and URIs.

Use Cases

Standardizing documentation across a large-scale SAP CAP or BTP project.
Reviewing existing APIs for compliance with SAP's official quality checklist.
Preparing an API for publication on the SAP API Business Hub.

About

Key Features

Provides standardized templates for REST and OData documentation hierarchy levels.
11 GitHub stars
Generates OpenAPI 3.0.3 and OData specifications compliant with SAP Business Hub.
Implements SAP-specific deprecation policies and lifecycle state metadata (x-sap-stateInfo).
Guides source code documentation for Java (Javadoc), JS (JSDoc), and .NET (XML).
Applies official SAP naming conventions for resources, parameters, and URIs.

Use Cases

Standardizing documentation across a large-scale SAP CAP or BTP project.
Reviewing existing APIs for compliance with SAP's official quality checklist.
Preparing an API for publication on the SAP API Business Hub.