From 23ec14a176aade4e2e1e521b43b7b851100f98fd Mon Sep 17 00:00:00 2001 From: apidesigner Date: Mon, 19 Jun 2017 08:51:49 +0000 Subject: [PATCH] Updates core-principles/implementation-maturity.md Auto commit by GitBook Editor --- core-principles/design-maturity.md | 18 +++++++++++++++--- core-principles/implementation-maturity.md | 3 --- 2 files changed, 15 insertions(+), 6 deletions(-) diff --git a/core-principles/design-maturity.md b/core-principles/design-maturity.md index cbf7869..05a8300 100644 --- a/core-principles/design-maturity.md +++ b/core-principles/design-maturity.md @@ -1,4 +1,16 @@ -# Design Maturity -Every API design MUST be **resource-centric** ([Web API Design Maturity Model Level 2](http://amundsen.com/talks/2016-11-apistrat-wadm/2016-11-apistrat-wadm.pdf)). That is an API design MUST revolve around Web-styled **resources**, **relations** between the resources and the **actions** the resources might afford. +# Design & Implementation Maturity -An API design MAY be **affordance-centric** ([Web API Design Maturity Model Level 3](http://amundsen.com/talks/2016-11-apistrat-wadm/2016-11-apistrat-wadm.pdf)). +## API Design Maturity +> How to design an API + + +Every API design **MUST** be **resource-centric** ([Web API Design Maturity Model Level 2](http://amundsen.com/talks/2016-11-apistrat-wadm/2016-11-apistrat-wadm.pdf)). That is an API design **MUST** revolve around Web-styled _resources_, _relations_ between the resources and the _actions_ the resources may afford. + +An API design **MAY** be **affordance-centric** ([Web API Design Maturity Model Level 3](http://amundsen.com/talks/2016-11-apistrat-wadm/2016-11-apistrat-wadm.pdf)). + +## API Design Implementation +> How to implement the API design + +Every API design implementation using the HTTP(S) protocol **MUST** use the appropriate **HTTP Request Method** ([Richardson Maturity Model Level 2](https://martinfowler.com/articles/richardsonMaturityModel.html#level2)) to implement an action afforded by a resource. + +An API design implementation **SHOULD** include **hypermedia controls** (HATEOAS) ([Richardson Maturity Model Level 3](https://martinfowler.com/articles/richardsonMaturityModel.html#level3)). diff --git a/core-principles/implementation-maturity.md b/core-principles/implementation-maturity.md index ffaf982..88cd20d 100644 --- a/core-principles/implementation-maturity.md +++ b/core-principles/implementation-maturity.md @@ -1,4 +1 @@ # Implementation Maturity -Every API design using the HTTP(S) protocol **MUST** use the appropriate **HTTP Request Method** ([Richardson Maturity Model Level 2](https://martinfowler.com/articles/richardsonMaturityModel.html#level2)) to implement an action afforded by a resource. - -An API design implementation SHOULD include **hypermedia controls** (HATEOAS) ([Richardson Maturity Model Level 3](https://martinfowler.com/articles/richardsonMaturityModel.html#level3)).