diff --git a/general-guidelines/minimal-api-surface.md b/general-guidelines/minimal-api-surface.md index 839675d..507ace1 100644 --- a/general-guidelines/minimal-api-surface.md +++ b/general-guidelines/minimal-api-surface.md @@ -1,4 +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\)](https://martinfowler.com/bliki/Yagni.html%29\)\). - +# 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)).