Patterns by Scope
Which pattern to read when working on…
…API as a whole:
API Description |
Aggressive Obsolescence |
Backend Integration |
Community API |
Eternal Lifetime Guarantee |
Experimental Preview |
Frontend Integration |
Limited Lifetime Guarantee |
Pricing Plan |
Public API |
Semantic Versioning |
Service Level Agreement |
Solution-Internal API |
Two in Production |
Version Identifier |
…API endpoint:
Aggressive Obsolescence |
Data Transfer Resource |
Eternal Lifetime Guarantee |
Experimental Preview |
Information Holder Resource |
Limited Lifetime Guarantee |
Link Lookup Resource |
Master Data Holder |
Operational Data Holder |
Pricing Plan |
Processing Resource |
Rate Limit |
Reference Data Holder |
Semantic Versioning |
Service Level Agreement |
Two in Production |
Version Identifier |
…operation:
API Key |
Computation Function |
Conditional Request |
Pagination |
Rate Limit |
Request Bundle |
Retrieval Operation |
State Creation Operation |
State Transition Operation |
Wish List |
Wish Template |
…message representation:
Atomic Parameter |
Atomic Parameter List |
Context Representation |
Data Element |
Embedded Entity |
Error Report |
Id Element |
Link Element |
Linked Information Holder |
Metadata Element |
Parameter Forest |
Parameter Tree |
…API documentation:
Not what you are looking for? Our pattern classifications by role, by phase or by quality suggest alternative entry points into the language.
Pattern Index
A complete list of all published patterns can be found in the Pattern Index.
Cheat Sheet
You can also try our Cheat Sheet.