From e87d496afcd74995b84caefa3a5a9d63e31e89a8 Mon Sep 17 00:00:00 2001 From: Bastian Ike Date: Wed, 13 Apr 2022 10:55:49 +0200 Subject: [PATCH] adopt api-first design --- radar/2022-03-28/api-first-design-approach.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 radar/2022-03-28/api-first-design-approach.md diff --git a/radar/2022-03-28/api-first-design-approach.md b/radar/2022-03-28/api-first-design-approach.md new file mode 100644 index 0000000..a1a208e --- /dev/null +++ b/radar/2022-03-28/api-first-design-approach.md @@ -0,0 +1,10 @@ +--- +title: "API-First Design Approach" +ring: adopt +quadrant: methods-and-patterns +--- + +The API of any software we develop shapes in which way developers, teams, customers and users interact with our software. +No matter if a Frontend-API like GraphQL, a rpc-API like gRPC or an internal API published by a module in a larger project or shared library, messing the API up always creates headaches and is hard to correct. +If we stick to semantic versioning, it's actually pretty impossible to change a once-published API without breaking consumers. +By todays standards we priorize API design before actual development, to be clear on how our software interacts, and thus move this pattern to "adopt".