[{"data":1,"prerenderedAt":301},["ShallowReactive",2],{"content-svc-api-gateway-paved-path-building-an-api-platform-on-aws-discover":3},{"markdown":4,"frontMatterAttributes":5,"bodyRaw":23,"menu":24,"menuType":295,"isCollapseableMenu":27,"nextDocItem":296,"previousDocItem":274,"contributorPaths":297,"contentName":300,"slug":294,"readingTime":84},"\u003Cp>As you scale the number of API products, consumers need an easy way to discover your APIs and build integrations. For a few APIs that do not change often, a static web page may be a good enough solution. When you have many public facing APIs, the developer portal becomes a critical feature to reduce adoption barriers. It would allow users to sign up, generate API keys, try out APIs, generate SDKs, and even pay for subscriptions.\u003C\u002Fp>\n\u003Ch2>AWS managed developer portal\u003C\u002Fh2>\n\u003Cp>Amazon API Gateway provides a fully managed portal feature, Amazon API Gateway Portal, that integrates with the API Gateway service and offers features like API products, interactive “Try it” functionality, and documentation for your API portfolio. See \u003Ca href=\"https:\u002F\u002Fdocs.aws.amazon.com\u002Fapigateway\u002Flatest\u002Fdeveloperguide\u002Fportals.html\">Developer Guide\u003C\u002Fa> to get started.\u003C\u002Fp>\n\u003Cp>\u003Cimg src=\"\u002Fassets\u002Fexternal\u002Fservice\u002Fapi-gateway\u002Fpaved-path\u002Fbuilding-an-api-platform-on-aws\u002Fassets\u002F11_dev_portal.png\" alt=\"API gateway developer portal\">\u003C\u002Fp>\n\u003Ch2>Open source solutions\u003C\u002Fh2>\n\u003Cp>You may also consider \u003Ca href=\"https:\u002F\u002Fgithub.com\u002Fbackstage\u002Fbackstage\">Backstage\u003C\u002Fa> - an open sourced CNCF project for building developer portals. It can be self-hosted on ECS or EKS, provides a rich ecosystem of plugins, and is more than just a developer portal.\u003C\u002Fp>\n\u003Cp>\u003Cimg src=\"\u002Fassets\u002Fexternal\u002Fservice\u002Fapi-gateway\u002Fpaved-path\u002Fbuilding-an-api-platform-on-aws\u002Fassets\u002F11_backstage.png\" alt=\"Backstage developer portal\">\u003C\u002Fp>\n\u003Ch2>Partner solutions\u003C\u002Fh2>\n\u003Cp>AWS partners also offer developer portal solutions, both self-hosted and managed. They often offer more than just a developer portal - such as documentation, monetization, and a knowledge base. Here is a non-exhaustive list of the partners:\u003C\u002Fp>\n\u003Cul>\n\u003Cli>\u003Ca href=\"https:\u002F\u002Freadme.com\u002F\">Readme\u003C\u002Fa>\u003C\u002Fli>\n\u003Cli>\u003Ca href=\"https:\u002F\u002Fwww.apiable.io\u002F\">Apiable\u003C\u002Fa>\u003C\u002Fli>\n\u003Cli>SmartBear \u003Ca href=\"https:\u002F\u002Fswagger.io\u002Ftools\u002Fapi-hub\u002F\">API Hub\u003C\u002Fa>\u003C\u002Fli>\n\u003Cli>\u003Ca href=\"https:\u002F\u002Fstoplight.io\u002F\">Stoplight\u003C\u002Fa>\u003C\u002Fli>\n\u003C\u002Ful>\n",{"title":6,"order":7,"resources":8},"Discover",11,[9,13,17,20],{"link":10,"text":11,"type":12},"https:\u002F\u002Fdocs.aws.amazon.com\u002Fapigateway\u002Flatest\u002Fdeveloperguide\u002Fportals.html","API Gateway developer portals","Documentation",{"link":14,"text":15,"type":16},"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","Blog",{"link":18,"text":19,"type":16},"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":21,"text":22,"type":16},"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","As you scale the number of API products, consumers need an easy way to discover your APIs and build integrations. For a few APIs that do not change often, a static web page may be a good enough solution. When you have many public facing APIs, the developer portal becomes a critical feature to reduce adoption barriers. It would allow users to sign up, generate API keys, try out APIs, generate SDKs, and even pay for subscriptions.\n\n## AWS managed developer portal\nAmazon API Gateway provides a fully managed portal feature, Amazon API Gateway Portal, that integrates with the API Gateway service and offers features like API products, interactive “Try it” functionality, and documentation for your API portfolio. See [Developer Guide](https:\u002F\u002Fdocs.aws.amazon.com\u002Fapigateway\u002Flatest\u002Fdeveloperguide\u002Fportals.html) to get started.\n\n![API gateway developer portal](\u002Fassets\u002Fexternal\u002Fservice\u002Fapi-gateway\u002Fpaved-path\u002Fbuilding-an-api-platform-on-aws\u002Fassets\u002F11_dev_portal.png)\n\n## Open source solutions\nYou may also consider [Backstage](https:\u002F\u002Fgithub.com\u002Fbackstage\u002Fbackstage) - an open sourced CNCF project for building developer portals. It can be self-hosted on ECS or EKS, provides a rich ecosystem of plugins, and is more than just a developer portal.\n\n![Backstage developer portal](\u002Fassets\u002Fexternal\u002Fservice\u002Fapi-gateway\u002Fpaved-path\u002Fbuilding-an-api-platform-on-aws\u002Fassets\u002F11_backstage.png)\n\n## Partner solutions\nAWS partners also offer developer portal solutions, both self-hosted and managed. They often offer more than just a developer portal - such as documentation, monetization, and a knowledge base. Here is a non-exhaustive list of the partners:\n- [Readme](https:\u002F\u002Freadme.com\u002F)\n- [Apiable](https:\u002F\u002Fwww.apiable.io\u002F)\n- SmartBear [API Hub](https:\u002F\u002Fswagger.io\u002Ftools\u002Fapi-hub\u002F)\n- [Stoplight](https:\u002F\u002Fstoplight.io\u002F)\n",[25,47,55,88,130,178,202,225,249,271,284],{"title":26,"collapsible":27,"isCollapsed":28,"content":29},"Introduction",false,true,[30],{"title":26,"order":31,"learningGoals":32,"prerequisite":35,"resources":38,"time":43,"path":44,"id":45,"link":46},1,[33,34],"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.",[36,37],"Understanding of API management","Understanding of Amazon API Gateway",[39],{"link":40,"text":41,"type":42},"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":48,"collapsible":27,"isCollapsed":28,"content":49},"API Lifecycle",[50],{"title":48,"order":51,"time":43,"path":52,"id":53,"link":54},2,"api_lifecycle","api_lifecycle.md","\u002Fcontent\u002Fservice\u002Fapi-gateway\u002Fpaved-path\u002Fbuilding-an-api-platform-on-aws\u002Fapi_lifecycle",{"title":56,"collapsible":27,"isCollapsed":28,"content":57},"Plan",[58],{"title":56,"order":59,"resources":60,"time":84,"path":85,"id":86,"link":87},3,[61,65,69,72,75,78,81],{"link":62,"text":63,"type":64},"https:\u002F\u002Fwww.youtube.com\u002Fwatch?v=U6Zz_Bj6yEY","Building APIs: Choosing the best API solution & strategy for workloads","Video",{"link":66,"text":67,"type":68},"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":70,"text":71,"type":16},"https:\u002F\u002Faws.amazon.com\u002Fblogs\u002Fcompute\u002Fimplementing-multi-region-failover-for-amazon-api-gateway\u002F","Implementing multi-Region failover for Amazon API Gateway",{"link":73,"text":74,"type":16},"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":76,"text":77,"type":16},"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":79,"text":80,"type":16},"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":82,"text":83,"type":64},"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":89,"collapsible":27,"isCollapsed":28,"content":90},"Develop\u002FTest",[91],{"title":89,"order":92,"resources":93,"time":126,"path":127,"id":128,"link":129},4,[94,97,100,103,106,109,112,116,119,123],{"link":95,"text":96,"type":64},"https:\u002F\u002Fwww.youtube.com\u002Fwatch?v=yfJZc3sJZ8E","I didn’t know Amazon API Gateway did that",{"link":98,"text":99,"type":16},"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":101,"text":102,"type":16},"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":104,"text":105,"type":16},"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":107,"text":108,"type":16},"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":110,"text":111,"type":16},"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":113,"text":114,"type":115},"https:\u002F\u002Fgithub.com\u002Faws-samples\u002Fserverless-samples\u002Ftree\u002Fmain\u002Fserverless-rest-api","Sample REST API implementations","Example",{"link":117,"text":118,"type":115},"https:\u002F\u002Fgithub.com\u002Faws-samples\u002Fserverless-samples\u002Ftree\u002Fmain\u002Fapigw-ai-agents","API developer experience customization and centralized guidance using AI Agents",{"link":120,"text":121,"type":122},"https:\u002F\u002Fcatalog.workshops.aws\u002Fapigateway","The Amazon API Gateway Workshop","Workshop",{"link":124,"text":125,"type":122},"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":131,"collapsible":27,"isCollapsed":28,"content":132},"Secure",[133],{"title":131,"order":134,"resources":135,"time":126,"path":175,"id":176,"link":177},5,[136,139,142,146,149,152,155,158,161,164,167,170,173,174],{"link":137,"text":138,"type":12},"https:\u002F\u002Fdocs.aws.amazon.com\u002Fapigateway\u002Flatest\u002Fdeveloperguide\u002Fsecurity.html","Security in Amazon API Gateway",{"link":140,"text":141,"type":68},"https:\u002F\u002Fdocs.aws.amazon.com\u002Fwhitepapers\u002Flatest\u002Fsecurity-overview-amazon-api-gateway\u002Fabstract-and-introduction.html","Security Overview of Amazon API Gateway",{"link":143,"text":144,"type":145},"https:\u002F\u002Fserverlessland.com\u002Fcontent\u002Fguides\u002Fapi-gateway-governance\u002Fintroduction","Amazon API Gateway governance in depth","Guide",{"link":147,"text":148,"type":16},"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":150,"text":151,"type":16},"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":153,"text":154,"type":16},"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":156,"text":157,"type":16},"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":159,"text":160,"type":16},"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":162,"text":163,"type":16},"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":165,"text":166,"type":16},"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":168,"text":169,"type":64},"https:\u002F\u002Fwww.youtube.com\u002Fwatch?v=GvyyJQ5m7x0","Scaling and securing private workloads using Amazon API Gateway",{"link":171,"text":172,"type":64},"https:\u002F\u002Fwww.youtube.com\u002Fwatch?v=H4hCygngTrU","API Gateway private integrations | Serverless Office Hours",{"link":120,"text":121,"type":122},{"link":124,"text":125,"type":122},"secure","secure.md","\u002Fcontent\u002Fservice\u002Fapi-gateway\u002Fpaved-path\u002Fbuilding-an-api-platform-on-aws\u002Fsecure",{"title":179,"collapsible":27,"isCollapsed":28,"content":180},"Deploy\u002FPublish",[181],{"title":179,"order":182,"resources":183,"time":43,"path":199,"id":200,"link":201},6,[184,187,190,193,195,198],{"link":185,"text":186,"type":16},"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":188,"text":189,"type":16},"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":191,"text":192,"type":16},"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":113,"text":194,"type":115},"Sample REST API implementations with CI\u002FCD pipelines",{"link":196,"text":197,"type":122},"https:\u002F\u002Fcatalog.workshops.aws\u002Fcomplete-aws-sam\u002Fen-US","The Complete AWS SAM Workshop",{"link":124,"text":125,"type":122},"deploy","deploy.md","\u002Fcontent\u002Fservice\u002Fapi-gateway\u002Fpaved-path\u002Fbuilding-an-api-platform-on-aws\u002Fdeploy",{"title":203,"collapsible":27,"isCollapsed":28,"content":204},"Scale",[205],{"title":203,"order":206,"resources":207,"time":43,"path":222,"id":223,"link":224},7,[208,211,215,218,221],{"link":209,"text":210,"type":16},"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":212,"text":213,"type":214},"https:\u002F\u002Frepost.aws\u002Fquestions\u002FQUSs8ODCyJSRWR7mawaUIl4g\u002Fmulti-region-strategy-for-api-gateway","Multi Region strategy for API Gateway","re:Post",{"link":216,"text":217,"type":16},"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":219,"text":220,"type":16},"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":168,"text":169,"type":64},"scale","scale.md","\u002Fcontent\u002Fservice\u002Fapi-gateway\u002Fpaved-path\u002Fbuilding-an-api-platform-on-aws\u002Fscale",{"title":226,"collapsible":27,"isCollapsed":28,"content":227},"Monitor",[228],{"title":226,"order":229,"resources":230,"time":245,"path":246,"id":247,"link":248},8,[231,234,237,240,242],{"link":232,"text":233,"type":12},"https:\u002F\u002Fdocs.aws.amazon.com\u002Fapigateway\u002Flatest\u002Fdeveloperguide\u002Frest-api-monitor.html","Monitoring REST APIs",{"link":235,"text":236,"type":12},"https:\u002F\u002Fdocs.aws.amazon.com\u002Fapigateway\u002Flatest\u002Fdeveloperguide\u002Fhttp-api-monitor.html","Monitoring your HTTP API",{"link":238,"text":239,"type":12},"https:\u002F\u002Fdocs.aws.amazon.com\u002Fapigateway\u002Flatest\u002Fdeveloperguide\u002Fwebsocket-api-monitor.html","Monitoring WebSocket APIs",{"link":113,"text":241,"type":115},"Sample REST API implementations with business specific metrics, dashboards and alerts in IaC templates",{"link":243,"text":244,"type":122},"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":250,"collapsible":27,"isCollapsed":28,"content":251},"Insights",[252],{"title":250,"order":253,"resources":254,"time":84,"path":268,"id":269,"link":270},9,[255,258,261,264,267],{"link":256,"text":257,"type":16},"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":259,"text":260,"type":16},"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":262,"text":263,"type":16},"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":265,"text":266,"type":115},"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":243,"text":244,"type":122},"insights","insights.md","\u002Fcontent\u002Fservice\u002Fapi-gateway\u002Fpaved-path\u002Fbuilding-an-api-platform-on-aws\u002Finsights",{"title":272,"collapsible":27,"isCollapsed":28,"content":273},"Monetize",[274],{"title":272,"order":275,"resources":276,"time":84,"path":281,"id":282,"link":283},10,[277,278],{"link":256,"text":257,"type":16},{"link":279,"text":280,"type":16},"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":6,"collapsible":27,"isCollapsed":27,"content":285},[286],{"title":6,"order":7,"resources":287,"time":84,"path":292,"id":293,"link":294},[288,289,290,291],{"link":10,"text":11,"type":12},{"link":14,"text":15,"type":16},{"link":18,"text":19,"type":16},{"link":21,"text":22,"type":16},"discover","discover.md","\u002Fcontent\u002Fservice\u002Fapi-gateway\u002Fpaved-path\u002Fbuilding-an-api-platform-on-aws\u002Fdiscover","LESSON",null,[298,299],"content\u002Fcontributors\u002Farthi-jaganathan.json","content\u002Fcontributors\u002Fgiedrius-praspaliauskas.json","Building an API platform on AWS",1792665265363]