Building APIs That Last for Decades - Irakli Nadareishvili, Director of API Strategy, API Academy
•
7 j'aime•1,464 vues
Irakli Nadareishvili's, Director of API Strategy for CA API Academy, speaking session for Nordic APIs was on "Building APIs That Last for Decades"
Recommandé
Recommandé
Contenu connexe
Tendances
Tendances (20)
En vedette
En vedette (20)
Similaire à Building APIs That Last for Decades - Irakli Nadareishvili, Director of API Strategy, API Academy
Similaire à Building APIs That Last for Decades - Irakli Nadareishvili, Director of API Strategy, API Academy (20)
Plus de CA API Management
Plus de CA API Management (14)
Building APIs That Last for Decades - Irakli Nadareishvili, Director of API Strategy, API Academy
- 2. !?! BUT WHY?
- 4. 2013: 80 devices /sec Source:!Cisco!
- 5. 2014: 100 devices /sec Source:!Cisco!
- 6. 2020: 250 devices /sec Source:!Cisco!
- 7. 2020: 50bn conn. devices Source:!Cisco!
- 12. !
- 15. Hypermedia-Oriented Style What!if!the!server!could!dynamically! tell!the!client!what!the!client!can!do! and!how,!guiding!the!client!from!one! desired!state!to!another?! Avoid&'ght&coupling&and&hardcoding!& @inadarei
- 16. Response = Data + Controls API!server!would!have!to!send!client! not!just!sta$c!data,!but!also!controls! describing!API!affordances.! @inadarei
- 17. Hypermedia per Fielding "Hypermedia!is!defined!by!the!presence!of! applicaQon!control!informaQon!embedded! within,!or!as!a!layer!above,!the! presentaQon!of!informaQon!(2001)! Architectural!Styles!and!the!Design!of! NetworkFbased!SoGware,!2001! F!Roy!T.!Fielding!
- 18. Affordances Affordances!are!all!acQon!possibiliQes! latent!in!the!environment.! ! @inadarei Theory!of!Affordances,!1979! F!James!J.!Gibson! !
- 21. Affordances’re key to a good design Imagine!a!car!or!a!building!that!you!couldn't! possibly!use,!unless!you!had!a!manual.!That! sounds!silly,!we!don't!build!cars!or!buildings! like!that.!Yet,!that!is!exactly!how!we!build! APIs!today.!
- 22. Familiarity Creates Usability Are!all!cars!exactly!the!same?!No.!Can!we!do! basic!things!with!any!car,!once!we!understand! how!cars!in!general!work?!Yes!!Do!we!need!to! read!a!manual!for!that?!No!!
- 23. Common vocabulary: in Media Types paginaQon,!internaQonalizaQon,!templated!querying,!data!updates…!
- 24. Semantic GAP
- 25. Profiles RFC6906:!! [Profile!link!relaQon!defines]!addiQonal! semanQcs!that!can!be!used!to!process!a! resource!representaQon,!such!as!constraints,! convenQons,!extensions,!or!any!other!aspects! that!do!not!alter!the!basic!media!type!semanQcs! Profiles!can!be!combined,!meaning!that!a!single! resource!representaQon!can!conform!to!zero!or! any!number!of!profiles.!
- 26. Profile Examples: 1. XMDP (HTML-only) http://gmpg.org/xmdp/ 2. PMP (CDoc-only) https://github.com/publicmediaplatform/pmpdocs/ wiki/Profile-profile 3. ALPS http://www.ietf.org/id/draft-amundsen-richardson-foster- alps-00.txt And!many!others…!
- 27. OMG! This Feels So Complicated! @inadarei
- 28. No, It Is Not Complicated! You!are!already!very!familiar!with!all!of!it:!World! Wide!Web!is!a!perfect!Hypermedia!system!and! HTML!is!one!of!the!most!successful!hypermedia! types.! @inadarei
- 29. When in doubt: Always!draw!parallels!with!web!and!think!about:! “—Ok,sohowwouldIdothisifIwasjust buildingawebsiteandthiswasjustHTML?” @inadarei Bingo! Except!HTML![usually]!deals!with!unstructured!content!and! is!not!always!appropriate!for!APIs!that!marshal!structured! data.!Let’s!do!a!ligle!more!of!the!learning!thing.!
- 30. 7-Step Design Process 1. List Semantic Descriptors 2. Draw a State Diagram 3. Reconcile Names 4. Choose a Media Type 5. Write a Profile 6. Implementation 7. Publication Source:!Richardson!!Amundsen,!Resiul!Web!APIs!
- 31. #2 State Diagram Example: Blog List of blog posts Create blog post Save post
- 32. #3 Reconcile Names 1. IANA Link Relations http://www.iana.org/assignments/link-relations/link-relations. xhtml 2. Microformats Link Relations http://microformats.org/wiki/existing-rel-values 3. Dublin Core Metadata Element Set, Version 1 http://dublincore.org/documents/dces/ Source:!M.!Amundsen,!UBER!Hypermedia!Format!
- 33. #4 Choose a Hypermedia Type 1. UBER (http://uberhypermedia.org) 2. Collection+JSON (Col.Doc) 3. HAL 4. Siren 5. JSON:API 6. HTML (yeap! Just ask Jon Moore)
- 34. 7-Step Design Process 1. List Semantic Descriptors 2. Draw a State Diagram 3. Reconcile Names 4. Choose a Media Type 5. Write a Profile 6. Implementation 7. Publication Source:!Richardson!!Amundsen,!Resiul!Web!APIs!
- 35. Who Uses Hypermedia APIs? 1. AWS Streaming API 2. ElasticPath Cortex 3. Comcast 4. Microsoft Lync 5. Paypal 6. Github 7. FoxyCart 8. Huddle 9. Public Media Platform 10. … You?
- 36. What now? 1. Follow @mamund 2. Follow @apiacademy 3. Follow @darrel_miller 4. Follow @jharmn 5. Follow @kinlane (always) 6. Follow @inadarei (if you want) 7. Dave Goldberg’s Hypermedia Resources: http://davejonathangoldberg.github.io/apis/hypermedia/2014/08/08/ hypermedia-resources/ 8. Hypermedia Google Group https://groups.google.com/forum/#!forum/hypermedia-web 9. UBER Google Group https://groups.google.com/forum/#!forum/uber-hypermedia Be involved. This is a super-active and exciting space!