API Lifecycle Manager by Steve Fonseca

Transcript

1. Intuit Confidential and Proprietary ‹#› API Lifecycle Manager Steven P Fonseca Services Architect for the CIO’s Office steven_fonseca@intuit.com steven.fonseca@gmail.com
2. Intuit Confidential and Proprietary ‹#› IT Delivering Services to Run the Business of Intuit Small Business Ecosystem Tax Ecosystem Consumer Ecosystem Finance Customer Experience Customer Payments Enterprise Risk Mgmt Legal & Compliance Financial Services Billing Mgmt Fulfillment Subscription Accounting Product Information Revenue Mgmt Commerce Marketing Care Entitlements Sales Contact Center Workforce Workforce Security Workforce Mgmt IT Service Mgmt Collaboration & Productivity Human Resource Mgmt Mergers, Acquisitions & Divestitures Workforce Care Data Enterprise Analytics
3. Intuit Confidential and Proprietary ‹#› We are on the Journey to Doing RESTful APIs Well (1) Opportunistic: We do things well locally a portion of the time but successes are not necessarily reproducible within teams nor across our organization. (2) Systematic: There are methods for the things we do well that enables repeatable success but methods are not available for all that we do and teams are still mastering what methods exist. (3) Enterprise: We have a comprehensive set of methods for the things we do that are well-understood and used across our entire organization, product quality is improved. (4) Measured: We measure outcomes effectively to drive execution improvements and we are successful at tuning whatever needs adjustment to be a better service delivery organization. Product quality continues to improve and execution becomes more efficient. (5) Industrialized: We regularly offer Intuit-leading methods to the enterprise and there are only small needs for organizational tuning. Products are consistently produced quickly and with high quality.
4. Intuit Confidential and Proprietary ‹#› • Problem – An immature industry does not offer sufficient tooling / automation to help us get our jobs done efficiently and with high quality • Solution – An web application that provides a comprehensive suite of tools, offered in alignment with lifecycle workflows – The CIO’s office has an in-house developed capability called API Lifecycle Manager • Examples – Propose: We need to maintain an evolving service portfolio that identifies APIs that we intend to implement in the long term – Elaborate: Self-service collection of API “use cases” across the enterprise – Design: API interface definition and best practice adherence checks – Implement: Code generation from design artifacts Gain Operational Efficiency and Product Quality by Using Tooling During Each Phase of the API Lifecycle Propose Plan Elaborate Design Implement Test Integrate Release Operate Deprecate Retire Archive
5. Intuit Confidential and Proprietary ‹#› Make API-Related Information Available via API Additional Resources Financial Control Release User Term Best Practice Standard Checklist … Example APIs /products/{id}/service-portfolio /products/{id}/resource-portfolio /apis/{id}/interface /apis/{id}/interface/request/schema /apis/{id}/lifecycle-history /apis/{id}/metadata /apis/{id}/documentation /apis/{id}/lifecycle-phase /resources/{id}/schema /services/{id}/mocking-try-it-uri /financial-controls/{id}/assessments /releases/{id}/release-date /terms/{id}/base-definition /apis/webs-direct-subscription-sign-up-v3.1/interface HTML RAML Swagger JSON
6. Intuit Confidential and Proprietary ‹#› Manage and Evolve a Portfolio of APIs as a Cohesive Set “API First” Design for the consumer Design for the Long Term Minimize Backend Constrained Design
7. Intuit Confidential and Proprietary ‹#› Manage Resource Definitions as with APIs, Auto- Generate Resource Portfolio Doc
8. Intuit Confidential and Proprietary ‹#› Enable Interface Documentation Contributions from Multiple Roles, Build Definitions from Multiple Sources, Utilize Standard Doc Elements across APIs …
9. Intuit Confidential and Proprietary ‹#› Experimental Capabilities
10. Intuit Confidential and Proprietary ‹#› Follow a Design First Approach and Govern “Official” API Modeling
11. Intuit Confidential and Proprietary ‹#› Comprehensively Collect Lifecycle Execution Data to Tune Organizational Effectiveness
12. Intuit Confidential and Proprietary ‹#› • Problem – Artifacts created during the lifecycle require review but reviews take time, are expensive, can be untimely, and are imperfect • Solution – Build governance APIs that automate self-service artifact checking • Examples – Design: Checks for required headers in an API definition, adherence to URL naming conventions, and information model consistency can be automated – Implementation: Checks against codebase management best practices can be automated such as XML Schema naming conventions, directory structure conventions, etc. Automate Best Practice Checks
13. Intuit Confidential and Proprietary ‹#› Look for Frictionless Ways to Deliver Information throughout the API Lifecycle Getting Started • Alexa, ask architect to provide introduction • Alexa, ask architect for help with Project Management Project Management • Alexa, ask architect who is the functional architect for Get Subscription • Alexa, ask architect what is the current phase for Create Account • Alexa, ask architect for APIs included in the Brazil release Information Architecture • Alexa, ask architect what is a Subscription • Alexa, ask architect to lookup the Offer resource Products • Alexa, ask architect to look up the service portfolio for WEBS Financial Controls • Alexa, ask architect to look up financial control with name Master Pricing Catalog Referencing User • Alexa, ask architect to look up contact information for Steven Luke APIs • Alexa, ask architect for Create Account Version 1.0 interface Services Architect Assistant An intelligent speech interface to API Lifecycle Manager that provides full lifecycle tool support for services development