sap-api-stylelisted
Install: claude install-skill williamcorrea23/sap-router-skill
# SAP API Style Guide
API documentation standards following SAP guidelines.
## OData API Naming
| Entity | Convention | Example |
|---|---|---|
| Entity Set | Plural Noun | Products, SalesOrders |
| Entity Type | Singular Noun | Product, SalesOrder |
| Property | PascalCase | MaterialNumber, CreatedAt |
| Navigation Property | Prefix "to_" | to_ProductText, to_Supplier |
| Function Import | Verb-Noun | GetTopCustomers, ValidateOrder |
## OpenAPI Document Structure
```yaml
openapi: 3.0.3
info:
title: Product Management API
version: "1.0.0"
description: |
Manages product master data in SAP S/4HANA.
Scope: MM module, product lifecycle from creation to archival.
servers:
- url: https://my-s4hana.sap.com/sap/opu/odata/sap/Z_PRODUCT_API
paths:
/Products:
get:
summary: List products
parameters:
- name: $filter
in: query
description: OData filter (e.g. MaterialType eq 'FERT')
schema: { type: string }
responses:
'200':
description: Product list
content:
application/json:
schema:
$ref: '#/components/schemas/ProductsList'
post:
summary: Create product
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ProductCreate'
```
## Documentation Checklist
1. API title and version
2. Authentication method (Basic Auth, OAuth2, API Key)
3.