mirror of
https://github.com/adidas/api-guidelines.git
synced 2025-10-25 15:19:19 +00:00
Updates core-principles/robustness.md
Auto commit by GitBook Editor
This commit is contained in:
@@ -11,4 +11,5 @@
|
||||
* [Design Maturity](core-principles/design-maturity.md)
|
||||
* [Implementation Maturity](core-principles/implementation-maturity.md)
|
||||
* [Robustness](core-principles/robustness.md)
|
||||
* [Minimal API Surface](core-principles/minimal-api-surface.md)
|
||||
|
||||
|
||||
2
core-principles/minimal-api-surface.md
Normal file
2
core-principles/minimal-api-surface.md
Normal file
@@ -0,0 +1,2 @@
|
||||
# Minimal API Surface
|
||||
Every API design MUST aim for a minimal API surface without sacrificing on product requirements. API design SHOULD NOT include unnecessary resources, relations, actions or data. API design SHOULD NOT add functionality until deemed necessary ([YAGNI principle](https://martinfowler.com/bliki/Yagni.html)).
|
||||
@@ -4,5 +4,5 @@ Every API implementation and API consumer MUST follow Postel's law:
|
||||
> "Be conservative in what you send, be liberal in what you accept."
|
||||
> – [John Postel](https://en.wikipedia.org/wiki/Robustness_principle)
|
||||
|
||||
That is, send as little as possible (minimize the API surface) and be tolerant as possible while consuming another service ([tolerant reader](https://martinfowler.com/bliki/TolerantReader.html)).
|
||||
That is, send as little as possible and be tolerant as possible while consuming another service ([tolerant reader](https://martinfowler.com/bliki/TolerantReader.html)).
|
||||
|
||||
|
||||
Reference in New Issue
Block a user