API Design for Microservices with Apiary
0 likes72 views
The document discusses the significance of API design, emphasizing its role as a critical entry point for organizations' digital services. It highlights the benefits of an 'API-design first' approach, including reduced rework and parallel development. Additionally, it showcases tools like APIary for designing, building, and validating APIs in a collaborative manner.
API Design for Microservices with Apiary
- 1. © 2018 Capgemini. All rights reserved.1© 2018 Capgemini. All rights reserved. API Design for Microservices with Apiary Luis Weir Chief Architect – PaaS @ Capgemini @luisw19
- 2. © 2018 Capgemini. All rights reserved.2
- 3. © 2018 Capgemini. All rights reserved.3 About me Luis Weir Chief Architect at Capgemini UK Ace Director & Developer Champion [email protected] uk.linkedin.com/in/lweir @luisw19 http://www.soa4u.co.uk apiplatform.cloud/ Goes to Print Q2 2018 tinyurl.com/eapim18 Goes to Print Q3 2018 API Thought Leadership Award PaaS Community Split, April, 2018 Best New UK Speaker Birmingham, Dec, 2016 Cloud Contribution Award PaaS Community Valencia, March, 2016 API Thought Leadership Award PaaS Community March, 2018 • The 7 Deadly Sins of API Design • Setting the vision, strategy and direction — the CTO’s role • How can you design, deploy and manage your APIs? • The Spotify's Engineering Culture. My interpretation and summary • A comparison of API Gateways communication styles • Is BPM Dead, Long Live Microservices? • Five Minutes with Luis Weir • 2nd vs 3rd Generation API Platforms - A Comprehensive Comparison • Podcast: Are Microservices and APIs Becoming SOA 2.0? • 3rd-Generation API Management: From Proxies to Micro-Gateways • Oracle API Platform Cloud Service Overview Latest articles:
- 4. © 2018 Capgemini. All rights reserved.4 © 2018 Capgemini. All rights reserved.4 Agenda APIs & API Economy1 Case Study 12 Case Study 23
- 5. © 2018 Capgemini. All rights reserved.5 Application Programming Interfaces (APIs) are doors to information and functionality. They are an organisation’s main entrance to digital services and offerings
- 6. © 2018 Capgemini. All rights reserved.6 But even doors can be poorly designed…
- 7. © 2018 Capgemini. All rights reserved.7 7 API-design first to the rescue!
- 8. © 2018 Capgemini. All rights reserved.8 API-design first Feedback Design Build & Validate Package & Deploy Try Continuous Test Feedback RunAnalyse Feedback
- 9. © 2018 Capgemini. All rights reserved.9 9© 2018 Capgemini. All rights reserved. Design • API Blueprint (APIB) • Open API Spec (OAS) • Team compliance checks (ootb and custom) • Templating • Collaborative • GitHub sync • Rich CLI Mock Validate CapabilitiesWhy Apiary? • Auto-generates mocks • Client code generation in multiple langs • Runtime agnostic. Pre- integrated with Oracle API Platform but can be used against any runtime • Templating • Language agnostic REST API validation tool • APIB and OAS support • Open source Design Try Build & Validate
- 10. © 2018 Capgemini. All rights reserved.10 The demo (https://github.com/luisw19/aptd_2018) Feedback Design Build & Validate Package & DeployTry Continuous Test 01 • Create API Blueprint/OAS in Apiary • Use Apiary Mock endpoints to publish an API through the Oracle API platform • API docs and mock endpoints available in the Dev Portal • JET designers/developers try the API and give feedback • Build backend service using tech of choice • Apply Dredd to validate endpoints against spec 02 03 04 • Stablish a CICD pipeline for continuously and consistently packaging and deploying releases, e.g. using Wercker • Set up functional regression testing (e.g. using API Fortress or Postman) • Continuously validate endpoints using Dredd 05
- 11. © 2018 Capgemini. All rights reserved.11 Benefits of API-design first Avoid rework: feedback early in the cycle By getting feedback very early in the lifecycle, changes of rework late in the cycle are slim. Saving time and cost. 1 Parallel development: Decouple App dev from Service dev By defining APIs with API Blueprints or Swagger, app dev and service dev can occur in parallel. Up-to-date API documentation The API is only as good as it documentation. Continuous validation using Dredd add enormous value. 3 2
- 12. © 2018 Capgemini. All rights reserved.12 With more than 190,000 people, Capgemini is present in over 40 countries and celebrates its 50th Anniversary year in 2018. A global leader in consulting, technology and outsourcing services, the Group reported 2016 global revenues of EUR 12.5 billion. Together with its clients, Capgemini creates and delivers business, technology and digital solutions that fit their needs, enabling them to achieve innovation and competitiveness. A deeply multicultural organization, Capgemini has developed its own way of working, the Collaborative Business Experience™, and draws on Rightshore®, its worldwide delivery model. About Capgemini Learn more about us at www.capgemini.com This message contains information that may be privileged or confidential and is the property of the Capgemini Group. Copyright © 2018 Capgemini. All rights reserved. Rightshore® is a trademark belonging to Capgemini. This message is intended only for the person to whom it is addressed. If you are not the intended recipient, you are not authorized to read, print, retain, copy, disseminate, distribute, or use this message or any part thereof. If you receive this message in error, please notify the sender immediately and delete all copies of this message.