API Evangelist API Evangelist
API Learnings
Toolbox
API Evangelist LLC

Unique Identrifiers for API Operations

Requiring that all operational unique identifiers meets the policy standards.

Rules

OpenAPI Operations Operation Ids Error

Operation identifiers provide a unique way to identify each individual API, which then used for SDK generation and other automation

OpenAPI Operations Operation Ids Info

Operation identifiers provide a unique way to identify each individual API, which then used for SDK generation and other automation

OpenAPI Operations Operation Ids Camel Case Error

Operation identifiers provide a unique way to identify each individual API, and requiring them to have consistent casing reduces friction when generating SDKs and automating around APIs

OpenAPI Operations Operation Ids Camel Case Info

Operation identifiers provide a unique way to identify each individual API, and requiring them to have consistent casing reduces friction when generating SDKs and automating around APIs

Strategies

Operations Must Be Useful and Consistent

Every API operation should do one thing and do it well. That is the Unix philosophy applied to APIs and it still holds up. When your operations follow common standards with consistent naming, clear...