Automating the API Product Lifecycle
•
0 likes•551 views
Creating a successful API requires a proper process from concept and design, through development, and into ongoing maintenance and good developer support. There are many steps to a good API. As developer expectations for better-quality APIs increase, tools have made it easier to do this well. Looking at the full API Product Lifecycle to design an API people will use, Jeremy Glassenberg will share the newest tools -- and potentially upcoming opportunities -- to better automate the planning and creation of a solid developer program.
Report
Share
Automating the API Product Lifecycle
- 1. THE CLOUD CONNECTIVITY COMPANY Destination: Automation San Francisco, CA July 2020 THE CLOUD CONNECTIVITY COMPANY 1
- 2. THE CLOUD CONNECTIVITY COMPANY Automating the API Product Lifecycle 2
- 3. THE CLOUD CONNECTIVITY COMPANY 3 About Me Founder of the Box developer platform Early writer for ProgrammableWeb Managed these platforms Mentor, advisor, consultant for other developer platforms & accelerators
- 4. THE CLOUD CONNECTIVITY COMPANY Life before Swagger/OpenAPI 4
- 5. THE CLOUD CONNECTIVITY COMPANY Life before Swagger/OpenAPI Actually, it looked more like this 5 <sample> <id>238901423424</id> <value>15</value> <license>IH8XML</license> </sample> WADL
- 6. THE CLOUD CONNECTIVITY COMPANY And then came JSON… and Swagger And REST became easy And documentation became easy 6
- 7. THE CLOUD CONNECTIVITY COMPANY But what was the value? More Automation Tools Came Along Generate Swagger from Comments Generate Swagger and APIs from database schemas 7 https://github.com/swaggo/swag https://github.com/dbohdan/automatic-api
- 8. THE CLOUD CONNECTIVITY COMPANY It doesn’t work in Product, and won’t work for APIs If You Build It, They Will Come…? 8
- 9. THE CLOUD CONNECTIVITY COMPANY API Product LifeCycle 9 Manage the Developer Community - Developer Relationship Management - API Monitoring Maintain & Iterate Launch the API, Developer Experience - Documentation (Redoc, SwaggerHub) - SDKs (SwaggerHub, APImatic) - Dev Portal (Kong, AWS Dev Portal) Launch Build the API - AWS API Gateway, Kong, Apigee Implement Create Schema Definition for the API - IDEs (Postman, Insomnia) - OpenAPI Schema Design Establish High Level Architecture - Schema.org - GraphQL Vs REST Research Determine Value Points and Use Cases - Value Proposition Canvas - Business Model Canvas Identify
- 10. THE CLOUD CONNECTIVITY COMPANY Tools for the Lifecycle 10 Design DocumentationDeveloper Portal/App MarketplaceBuild Monitor
- 11. THE CLOUD CONNECTIVITY COMPANY IDEs Designing the API Kong Studio/Insomnia 11
- 12. THE CLOUD CONNECTIVITY COMPANY Code Creation, Code Minimization Building the API API Gateway Server Code Stubs 12
- 13. THE CLOUD CONNECTIVITY COMPANY Docs, Portals, Oh My! Developer Experience API Docs Kong Portal 13
- 14. THE CLOUD CONNECTIVITY COMPANY And SDKs! And Mock Servers Developer Experience OpenAPI Generator Prism 14 https://github.com/OpenAPITools/openapi-generator https://stoplight.io/open-source/prism/
- 15. THE CLOUD CONNECTIVITY COMPANY Sample Product Stack 15 1 API Designs Tools: Postman, OpenAPI Input: User Stories Output: OpenAPI 3 Developer Portal/Marketplace Tools: Kong Dev Portal, OpenChannel.io Input: OpenAPI Output: Developer Management site, Sandbox 5 API Code Tools: Kong Gateway Input: OpenAPI Output: Reverse Proxy and actual APIs API Documentation Tools: Redoc, Prism, APIMatic Input: OpenAPI Output: HTML docs, SDKs, Mock Server 4 Monitoring Tools: Moesif, Kong Vitals Input: OpenAPI Output: HTML docs 2
- 16. THE CLOUD CONNECTIVITY COMPANY Thinking outside the Box Future opportunities 16 https://jglassenberg.github.io/REST-API-Endpoint-Generator/demo POST GET GET {id} PUT PATCH DELETE
- 17. THE CLOUD CONNECTIVITY COMPANY Thinking outside the Box Visually planning OpenAPI 17
- 18. THE CLOUD CONNECTIVITY COMPANY Thinking outside the Box App Marketplace Frameworks 18
- 19. THE CLOUD CONNECTIVITY COMPANY Thinking Outside the Box Future opportunities 19 Full Server-Stubs
- 20. THE CLOUD CONNECTIVITY COMPANY Easier Management, Better APIs 20 Plugins
- 21. THE CLOUD CONNECTIVITY COMPANY 21 Thank You! jeremy.glassenberg@deserve.com
- 22. THE CLOUD CONNECTIVITY COMPANY API Product LifeCycle 22
- 26. THE CLOUD CONNECTIVITY COMPANY 26 Official logo, font, artwork, etc: https://drive.google.com/drive/u/0/folders/0BxmhCXr_QQfHbFVTS1BuN WplbFk Brand Guidelines: https://konghq.com/brand/ Other Design Resources Branding Assets
- 28. THE CLOUD CONNECTIVITY COMPANY TINY ICONS Access all Kong iconography here: https://drive.google.com/drive/folders/1DZE4TpyEEFtTYvlI0u9f8BJZmnrjhqih?usp=sharing 28
- 29. THE CLOUD CONNECTIVITY COMPANY 29 Block Title Icon Database DIAGRAMS Template Plugin Access all existing Kong diagrams here: https://drive.google.com/drive/folders/1TJkhy3TVIkj0Mw-XvAmGo38RF5q8zKqb?usp=sharing