[{"data":1,"prerenderedAt":295},["ShallowReactive",2],{"content-svc-api-gateway-paved-path-building-an-api-platform-on-aws-api_lifecycle":3},{"markdown":4,"frontMatterAttributes":5,"bodyRaw":8,"menu":9,"menuType":290,"isCollapseableMenu":12,"nextDocItem":41,"previousDocItem":15,"contributorPaths":291,"contentName":294,"slug":37,"readingTime":28},"\u003Cp>Let’s look at the four API lifecycle phases and 10 activities:\u003C\u002Fp>\n\u003Cp>\u003Cimg src=\"\u002Fassets\u002Fexternal\u002Fservice\u002Fapi-gateway\u002Fpaved-path\u002Fbuilding-an-api-platform-on-aws\u002Fassets\u002F2_lifecycle.png\" alt=\"API Lifecycle\">\u003C\u002Fp>\n\u003Cp>The design phase involves working backwards from business capabilities to identify the API contract. The steps will vary depending on the type of the API. For REST APIs, design identifies resources and methods. For GraphQL API, it defines the data model. Resulting design will serve as a basis for developing, testing and documenting the APIs. \u003C\u002Fp>\n\u003Cp>API management focuses on deployment and maintenance of APIs once deployed. It involves securing APIs, maintaining deployment pipelines, scaling and monitoring.\u003C\u002Fp>\n\u003Cp>Once APIs are in use, the usage data provides insights for optimizations. Monetization focuses on activities related to the revenue generation. \u003C\u002Fp>\n\u003Cp>Finally, as you scale the number of API products, consumers need an easy way to discover APIs and build integrations. Developer support is critical here to reduce adoption barriers.\u003C\u002Fp>\n\u003Cp>Here is another view of the API lifecycle which maps activities to the personas and teams performing them:\u003C\u002Fp>\n\u003Cp>\u003Cimg src=\"\u002Fassets\u002Fexternal\u002Fservice\u002Fapi-gateway\u002Fpaved-path\u002Fbuilding-an-api-platform-on-aws\u002Fassets\u002F2_personas.png\" alt=\"API Lifecycle\">\u003C\u002Fp>\n",{"title":6,"order":7},"API Lifecycle",2,"Let’s look at the four API lifecycle phases and 10 activities:\n\n![API Lifecycle](\u002Fassets\u002Fexternal\u002Fservice\u002Fapi-gateway\u002Fpaved-path\u002Fbuilding-an-api-platform-on-aws\u002Fassets\u002F2_lifecycle.png)\n\nThe design phase involves working backwards from business capabilities to identify the API contract. The steps will vary depending on the type of the API. For REST APIs, design identifies resources and methods. For GraphQL API, it defines the data model. Resulting design will serve as a basis for developing, testing and documenting the APIs. \n\nAPI management focuses on deployment and maintenance of APIs once deployed. It involves securing APIs, maintaining deployment pipelines, scaling and monitoring.\n\nOnce APIs are in use, the usage data provides insights for optimizations. Monetization focuses on activities related to the revenue generation. \n\nFinally, as you scale the number of API products, consumers need an easy way to discover APIs and build integrations. Developer support is critical here to reduce adoption barriers.\n\nHere is another view of the API lifecycle which maps activities to the personas and teams performing them:\n\n![API Lifecycle](\u002Fassets\u002Fexternal\u002Fservice\u002Fapi-gateway\u002Fpaved-path\u002Fbuilding-an-api-platform-on-aws\u002Fassets\u002F2_personas.png)\n\n\n",[10,32,38,72,114,163,187,210,234,256,269],{"title":11,"collapsible":12,"isCollapsed":13,"content":14},"Introduction",false,true,[15],{"title":11,"order":16,"learningGoals":17,"prerequisite":20,"resources":23,"time":28,"path":29,"id":30,"link":31},1,[18,19],"Understand API lifecycle and an AWS point of view on building an API platform using Amazon API Gateway.","Learn AWS options and partner solutions to build an API platform with Amazon API Gateway.",[21,22],"Understanding of API management","Understanding of Amazon API Gateway",[24],{"link":25,"text":26,"type":27},"https:\u002F\u002Faws.amazon.com\u002Fapi-gateway\u002F","Learn more about Amazon API Gateway","text","1 min","introduction","introduction.md","\u002Fcontent\u002Fservice\u002Fapi-gateway\u002Fpaved-path\u002Fbuilding-an-api-platform-on-aws\u002Fintroduction",{"title":6,"collapsible":12,"isCollapsed":12,"content":33},[34],{"title":6,"order":7,"time":28,"path":35,"id":36,"link":37},"api_lifecycle","api_lifecycle.md","\u002Fcontent\u002Fservice\u002Fapi-gateway\u002Fpaved-path\u002Fbuilding-an-api-platform-on-aws\u002Fapi_lifecycle",{"title":39,"collapsible":12,"isCollapsed":13,"content":40},"Plan",[41],{"title":39,"order":42,"resources":43,"time":68,"path":69,"id":70,"link":71},3,[44,48,52,56,59,62,65],{"link":45,"text":46,"type":47},"https:\u002F\u002Fwww.youtube.com\u002Fwatch?v=U6Zz_Bj6yEY","Building APIs: Choosing the best API solution & strategy for workloads","Video",{"link":49,"text":50,"type":51},"https:\u002F\u002Fdocs.aws.amazon.com\u002Fwhitepapers\u002Flatest\u002Fbest-practices-api-gateway-private-apis-integration\u002Fbest-practices-api-gateway-private-apis-integration.html","Best Practices for Designing Amazon API Gateway Private APIs and Private Integration","Whitepaper",{"link":53,"text":54,"type":55},"https:\u002F\u002Faws.amazon.com\u002Fblogs\u002Fcompute\u002Fimplementing-multi-region-failover-for-amazon-api-gateway\u002F","Implementing multi-Region failover for Amazon API Gateway","Blog",{"link":57,"text":58,"type":55},"https:\u002F\u002Faws.amazon.com\u002Fblogs\u002Fcompute\u002Farchitecting-multiple-microservices-behind-a-single-domain-with-amazon-api-gateway\u002F","Architecting multiple microservices behind a single domain with Amazon API Gateway",{"link":60,"text":61,"type":55},"https:\u002F\u002Faws.amazon.com\u002Fblogs\u002Fcompute\u002Fdynamically-routing-requests-with-amazon-api-gateway-routing-rules\u002F","Dynamically routing requests with Amazon API Gateway routing rules",{"link":63,"text":64,"type":55},"https:\u002F\u002Faws.amazon.com\u002Fblogs\u002Fcompute\u002Fusing-multiple-segments-in-amazon-api-gateway-base-path-mapping\u002F","Using multiple segments in Amazon API Gateway base path mapping",{"link":66,"text":67,"type":47},"https:\u002F\u002Fwww.youtube.com\u002Fwatch?v=JDbkoICzQro","Building well architected API Gateway APIs | Serverless Office Hours","2 min","plan","plan.md","\u002Fcontent\u002Fservice\u002Fapi-gateway\u002Fpaved-path\u002Fbuilding-an-api-platform-on-aws\u002Fplan",{"title":73,"collapsible":12,"isCollapsed":13,"content":74},"Develop\u002FTest",[75],{"title":73,"order":76,"resources":77,"time":110,"path":111,"id":112,"link":113},4,[78,81,84,87,90,93,96,100,103,107],{"link":79,"text":80,"type":47},"https:\u002F\u002Fwww.youtube.com\u002Fwatch?v=yfJZc3sJZ8E","I didn’t know Amazon API Gateway did that",{"link":82,"text":83,"type":55},"https:\u002F\u002Faws.amazon.com\u002Fblogs\u002Fcompute\u002Fbuilding-responsive-apis-with-amazon-api-gateway-response-streaming\u002F","Building responsive APIs with Amazon API Gateway response streaming",{"link":85,"text":86,"type":55},"https:\u002F\u002Faws.amazon.com\u002Fblogs\u002Fcompute\u002Fimplementing-custom-domain-names-for-private-endpoints-with-amazon-api-gateway\u002F","Implementing custom domain names for private endpoints with Amazon API Gateway",{"link":88,"text":89,"type":55},"https:\u002F\u002Faws.amazon.com\u002Fblogs\u002Fcompute\u002Fbuild-scalable-rest-apis-using-amazon-api-gateway-private-integration-with-application-load-balancer\u002F","Build scalable REST APIs using Amazon API Gateway private integration with Application Load Balancer",{"link":91,"text":92,"type":55},"https:\u002F\u002Faws.amazon.com\u002Fblogs\u002Fopensource\u002Fcreate-restful-apis-on-aws-with-openapi-specification-with-no-coding\u002F","Create RESTful APIs on AWS with OpenAPI Specification (With No Coding)",{"link":94,"text":95,"type":55},"https:\u002F\u002Faws.amazon.com\u002Fblogs\u002Fcompute\u002Fautomating-event-validation-with-amazon-eventbridge-schema-discovery\u002F","Automating event validation with Amazon EventBridge Schema Discovery",{"link":97,"text":98,"type":99},"https:\u002F\u002Fgithub.com\u002Faws-samples\u002Fserverless-samples\u002Ftree\u002Fmain\u002Fserverless-rest-api","Sample REST API implementations","Example",{"link":101,"text":102,"type":99},"https:\u002F\u002Fgithub.com\u002Faws-samples\u002Fserverless-samples\u002Ftree\u002Fmain\u002Fapigw-ai-agents","API developer experience customization and centralized guidance using AI Agents",{"link":104,"text":105,"type":106},"https:\u002F\u002Fcatalog.workshops.aws\u002Fapigateway","The Amazon API Gateway Workshop","Workshop",{"link":108,"text":109,"type":106},"https:\u002F\u002Fcatalog.workshops.aws\u002Fserverless-patterns\u002Fen-US","Serverless Patterns","3 min","develop","develop.md","\u002Fcontent\u002Fservice\u002Fapi-gateway\u002Fpaved-path\u002Fbuilding-an-api-platform-on-aws\u002Fdevelop",{"title":115,"collapsible":12,"isCollapsed":13,"content":116},"Secure",[117],{"title":115,"order":118,"resources":119,"time":110,"path":160,"id":161,"link":162},5,[120,124,127,131,134,137,140,143,146,149,152,155,158,159],{"link":121,"text":122,"type":123},"https:\u002F\u002Fdocs.aws.amazon.com\u002Fapigateway\u002Flatest\u002Fdeveloperguide\u002Fsecurity.html","Security in Amazon API Gateway","Documentation",{"link":125,"text":126,"type":51},"https:\u002F\u002Fdocs.aws.amazon.com\u002Fwhitepapers\u002Flatest\u002Fsecurity-overview-amazon-api-gateway\u002Fabstract-and-introduction.html","Security Overview of Amazon API Gateway",{"link":128,"text":129,"type":130},"https:\u002F\u002Fserverlessland.com\u002Fcontent\u002Fguides\u002Fapi-gateway-governance\u002Fintroduction","Amazon API Gateway governance in depth","Guide",{"link":132,"text":133,"type":55},"https:\u002F\u002Faws.amazon.com\u002Fblogs\u002Fcompute\u002Fenhancing-api-security-with-amazon-api-gateway-tls-security-policies\u002F","Enhancing API security with Amazon API Gateway TLS security policies",{"link":135,"text":136,"type":55},"https:\u002F\u002Faws.amazon.com\u002Fblogs\u002Fcompute\u002Faccessing-private-amazon-api-gateway-endpoints-through-custom-amazon-cloudfront-distribution-using-vpc-origins\u002F","Accessing private Amazon API Gateway endpoints through custom Amazon CloudFront distribution using VPC Origins",{"link":138,"text":139,"type":55},"https:\u002F\u002Faws.amazon.com\u002Fabout-aws\u002Fwhats-new\u002F2024\u002F04\u002Famazon-cognito-customers-access-apis-verified-permissions\u002F","Amazon Cognito customers can secure access to APIs using Amazon Verified Permissions",{"link":141,"text":142,"type":55},"https:\u002F\u002Faws.amazon.com\u002Fblogs\u002Fmt\u002Fconfiguring-machine-to-machine-authentication-with-amazon-cognito-and-amazon-api-gateway-part-1\u002F","Configuring machine to machine Authentication with Amazon Cognito and Amazon API Gateway – Part 1",{"link":144,"text":145,"type":55},"https:\u002F\u002Faws.amazon.com\u002Fblogs\u002Fmt\u002Fconfiguring-machine-to-machine-authentication-with-amazon-cognito-and-amazon-api-gateway-part-2\u002F","Configuring machine to machine Authentication with Amazon Cognito and Amazon API Gateway – Part 2",{"link":147,"text":148,"type":55},"https:\u002F\u002Faws.amazon.com\u002Fblogs\u002Fcompute\u002Fconsuming-private-amazon-api-gateway-apis-using-mutual-tls\u002F","Consuming private Amazon API Gateway APIs using mutual TLS",{"link":150,"text":151,"type":55},"https:\u002F\u002Faws.amazon.com\u002Fblogs\u002Farchitecture\u002Fhow-seatgeek-uses-aws-to-control-authorization-authentication-and-rate-limiting-in-a-multi-tenant-saas-application\u002F","How SeatGeek uses AWS Serverless to control authorization, authentication, and rate-limiting in a multi-tenant SaaS application",{"link":153,"text":154,"type":47},"https:\u002F\u002Fwww.youtube.com\u002Fwatch?v=GvyyJQ5m7x0","Scaling and securing private workloads using Amazon API Gateway",{"link":156,"text":157,"type":47},"https:\u002F\u002Fwww.youtube.com\u002Fwatch?v=H4hCygngTrU","API Gateway private integrations | Serverless Office Hours",{"link":104,"text":105,"type":106},{"link":108,"text":109,"type":106},"secure","secure.md","\u002Fcontent\u002Fservice\u002Fapi-gateway\u002Fpaved-path\u002Fbuilding-an-api-platform-on-aws\u002Fsecure",{"title":164,"collapsible":12,"isCollapsed":13,"content":165},"Deploy\u002FPublish",[166],{"title":164,"order":167,"resources":168,"time":28,"path":184,"id":185,"link":186},6,[169,172,175,178,180,183],{"link":170,"text":171,"type":55},"https:\u002F\u002Faws.amazon.com\u002Fblogs\u002Fcompute\u002Fzero-downtime-blue-green-deployments-with-amazon-api-gateway\u002F","Zero downtime blue\u002Fgreen deployments with Amazon API Gateway",{"link":173,"text":174,"type":55},"https:\u002F\u002Faws.amazon.com\u002Fblogs\u002Fcompute\u002Fperforming-canary-deployments-for-service-integrations-with-amazon-api-gateway\u002F","Performing canary deployments for service integrations with Amazon API Gateway",{"link":176,"text":177,"type":55},"https:\u002F\u002Faws.amazon.com\u002Fblogs\u002Fdevops\u002Fautomating-your-api-testing-with-aws-codebuild-aws-codepipeline-and-postman\u002F","Automating your API testing with AWS CodeBuild, AWS CodePipeline, and Postman",{"link":97,"text":179,"type":99},"Sample REST API implementations with CI\u002FCD pipelines",{"link":181,"text":182,"type":106},"https:\u002F\u002Fcatalog.workshops.aws\u002Fcomplete-aws-sam\u002Fen-US","The Complete AWS SAM Workshop",{"link":108,"text":109,"type":106},"deploy","deploy.md","\u002Fcontent\u002Fservice\u002Fapi-gateway\u002Fpaved-path\u002Fbuilding-an-api-platform-on-aws\u002Fdeploy",{"title":188,"collapsible":12,"isCollapsed":13,"content":189},"Scale",[190],{"title":188,"order":191,"resources":192,"time":28,"path":207,"id":208,"link":209},7,[193,196,200,203,206],{"link":194,"text":195,"type":55},"https:\u002F\u002Faws.amazon.com\u002Fblogs\u002Fcompute\u002Fbuilding-a-multi-region-serverless-application-with-amazon-api-gateway-and-aws-lambda\u002F","Building a Multi-region Serverless Application with Amazon API Gateway and AWS Lambda",{"link":197,"text":198,"type":199},"https:\u002F\u002Frepost.aws\u002Fquestions\u002FQUSs8ODCyJSRWR7mawaUIl4g\u002Fmulti-region-strategy-for-api-gateway","Multi Region strategy for API Gateway","re:Post",{"link":201,"text":202,"type":55},"https:\u002F\u002Faws.amazon.com\u002Fblogs\u002Fcompute\u002Fbuilding-resilient-private-apis-using-amazon-api-gateway\u002F","Building resilient private APIs using Amazon API Gateway",{"link":204,"text":205,"type":55},"https:\u002F\u002Faws.amazon.com\u002Fblogs\u002Fcompute\u002Farchitecting-for-scale-with-amazon-api-gateway-private-integrations\u002F","Architecting for scale with Amazon API Gateway private integrations",{"link":153,"text":154,"type":47},"scale","scale.md","\u002Fcontent\u002Fservice\u002Fapi-gateway\u002Fpaved-path\u002Fbuilding-an-api-platform-on-aws\u002Fscale",{"title":211,"collapsible":12,"isCollapsed":13,"content":212},"Monitor",[213],{"title":211,"order":214,"resources":215,"time":230,"path":231,"id":232,"link":233},8,[216,219,222,225,227],{"link":217,"text":218,"type":123},"https:\u002F\u002Fdocs.aws.amazon.com\u002Fapigateway\u002Flatest\u002Fdeveloperguide\u002Frest-api-monitor.html","Monitoring REST APIs",{"link":220,"text":221,"type":123},"https:\u002F\u002Fdocs.aws.amazon.com\u002Fapigateway\u002Flatest\u002Fdeveloperguide\u002Fhttp-api-monitor.html","Monitoring your HTTP API",{"link":223,"text":224,"type":123},"https:\u002F\u002Fdocs.aws.amazon.com\u002Fapigateway\u002Flatest\u002Fdeveloperguide\u002Fwebsocket-api-monitor.html","Monitoring WebSocket APIs",{"link":97,"text":226,"type":99},"Sample REST API implementations with business specific metrics, dashboards and alerts in IaC templates",{"link":228,"text":229,"type":106},"https:\u002F\u002Fcatalog.workshops.aws\u002Fserverless-observability","AWS Serverless Observability Workshop","5 min","monitor","monitor.md","\u002Fcontent\u002Fservice\u002Fapi-gateway\u002Fpaved-path\u002Fbuilding-an-api-platform-on-aws\u002Fmonitor",{"title":235,"collapsible":12,"isCollapsed":13,"content":236},"Insights",[237],{"title":235,"order":238,"resources":239,"time":68,"path":253,"id":254,"link":255},9,[240,243,246,249,252],{"link":241,"text":242,"type":55},"https:\u002F\u002Faws.amazon.com\u002Fblogs\u002Fcompute\u002Fvisualizing-amazon-api-gateway-usage-plans-using-amazon-quicksight\u002F","Visualizing Amazon API Gateway usage plans using Amazon QuickSight",{"link":244,"text":245,"type":55},"https:\u002F\u002Faws.amazon.com\u002Fblogs\u002Fbig-data\u002Flog-analytics-the-easy-way-with-amazon-opensearch-serverless\u002F","Log analytics the easy way with Amazon OpenSearch Serverless",{"link":247,"text":248,"type":55},"https:\u002F\u002Faws.amazon.com\u002Fblogs\u002Fawsmarketplace\u002Fhow-to-gain-api-observability-with-amazon-api-gateway-and-moesif-in-minutes\u002F","How to gain API observability with Amazon API Gateway and Moesif in minutes",{"link":250,"text":251,"type":99},"https:\u002F\u002Fgithub.com\u002Faws-samples\u002Fserverless-samples\u002Ftree\u002Fmain\u002Fapigw-log-analytic","Logging API Gateway access logs, analyzing and visualizing them using Amazon QuickSight",{"link":228,"text":229,"type":106},"insights","insights.md","\u002Fcontent\u002Fservice\u002Fapi-gateway\u002Fpaved-path\u002Fbuilding-an-api-platform-on-aws\u002Finsights",{"title":257,"collapsible":12,"isCollapsed":13,"content":258},"Monetize",[259],{"title":257,"order":260,"resources":261,"time":68,"path":266,"id":267,"link":268},10,[262,263],{"link":241,"text":242,"type":55},{"link":264,"text":265,"type":55},"https:\u002F\u002Faws.amazon.com\u002Fblogs\u002Fcompute\u002Fmonetize-your-apis-in-aws-marketplace-using-api-gateway\u002F","Monetize your APIs in AWS Marketplace using API Gateway","monetize","monetize.md","\u002Fcontent\u002Fservice\u002Fapi-gateway\u002Fpaved-path\u002Fbuilding-an-api-platform-on-aws\u002Fmonetize",{"title":270,"collapsible":12,"isCollapsed":13,"content":271},"Discover",[272],{"title":270,"order":273,"resources":274,"time":68,"path":287,"id":288,"link":289},11,[275,278,281,284],{"link":276,"text":277,"type":123},"https:\u002F\u002Fdocs.aws.amazon.com\u002Fapigateway\u002Flatest\u002Fdeveloperguide\u002Fportals.html","API Gateway developer portals",{"link":279,"text":280,"type":55},"https:\u002F\u002Faws.amazon.com\u002Fblogs\u002Fcompute\u002Fimprove-api-discoverability-with-the-new-amazon-api-gateway-portal\u002F","Improve API discoverability with the new Amazon API Gateway Portal",{"link":282,"text":283,"type":55},"https:\u002F\u002Faws.amazon.com\u002Fblogs\u002Fapn\u002Fintegrating-readme-with-amazon-api-gateway-to-keep-your-developer-hub-up-to-date\u002F","Integrating ReadMe with Amazon API Gateway to Keep Your Developer Hub Up to Date",{"link":285,"text":286,"type":55},"https:\u002F\u002Faws.amazon.com\u002Fblogs\u002Fapn\u002Fhow-to-streamline-api-development-on-amazon-api-gateway-using-smartbear-swaggerhub\u002F","How to Streamline API Development on Amazon API Gateway Using SmartBear’s API Hub","discover","discover.md","\u002Fcontent\u002Fservice\u002Fapi-gateway\u002Fpaved-path\u002Fbuilding-an-api-platform-on-aws\u002Fdiscover","LESSON",[292,293],"content\u002Fcontributors\u002Farthi-jaganathan.json","content\u002Fcontributors\u002Fgiedrius-praspaliauskas.json","Building an API platform on AWS",1792665265310]