markn.ca
Archive · · 3 min read

Amazon API Gateway Serverless Developer Portal

AWS Labs has a lot of open source code up on GitHub. This repo provides an easy way for developers to view your Amazon API Gateway APIs.

Amazon API Gateway Serverless Developer Portal

AWS Labs has a lot of open source code up on GitHub. This project, “Amazon API Gateway Serverless Developer Portal” builds a slick web interface for your Amazon API Gateway APIs.

Think of it like automatic documentation. It’s a great way to help developers get up to speed with your APIs.

I call out a few more details in the Twitter thread below…

Tweet 1/9 👇 Next tweet

this thread is going to look at "Amazon API Gateway Serverless Developer Portal" by @awscloud Labs on GitHub at https://github.com/awslabs/aws-api-gateway-developer-portal this project delivers a web portal for developer engagement with your APIs 🧵☁️ #cloud #devops

@marknca tweeted at 18-Nov-2021, 18:02

Tweet 2/9 👇 Next tweet 👆 Start

this thread is unrolled at https://t.co/4d3MidmVDs the last thread is at https://markn.ca/2021/amazon-s3-glacier-refreezer/ 🧵☁️ #cloud #devops

@marknca tweeted at 18-Nov-2021, 18:02

Tweet 3/9 👇 Next tweet 👆 Start

this is what this project builds out for you 👇 it's like fancy automated documentation + self-serve provisioning 🧵☁️ #cloud #devops

@marknca tweeted at 18-Nov-2021, 18:02

Tweet 4/9 👇 Next tweet 👆 Start

the project has spent a lot of time on deployment. you can roll it out via SAM, SAR, or script like good docs, that's very much appreciated more on SAM at https://aws.amazon.com/serverless/sam/ more on SAR at https://aws.amazon.com/serverless/serverlessrepo/ 🧵☁️ #cloud #devops

@marknca tweeted at 18-Nov-2021, 18:02

Tweet 5/9 👇 Next tweet 👆 Start

this project addresses a big gap for most teams. they might build out a solid API but how do you get the word out to developers? having clear documentation & a way to get an API key/token yourself is really important for the developer experience (#dx) 🧵☁️ #cloud #devops

@marknca tweeted at 18-Nov-2021, 18:02

Tweet 6/9 👇 Next tweet 👆 Start

this project doesn't go beyond the basic endpoint/parameters documentation. YOU need to add in the "here's how to get the most out of this API" and other, more in-depth documentation 🧵☁️ #cloud #devops

@marknca tweeted at 18-Nov-2021, 18:02

Tweet 7/9 👇 Next tweet 👆 Start

there's a fair bit of customization built into the project as well. you can adjust the branding and add your own content, like 👆 more on customization at https://github.com/awslabs/aws-api-gateway-developer-portal/wiki/Customization 🧵☁️ #cloud #devops

@marknca tweeted at 18-Nov-2021, 18:02

Tweet 8/9 👇 Next tweet 👆 Start

under the covers, here's what the project builds 👇 it's a pretty lightweight, #serverless build. that will keep operations light and the costs low 🧵☁️ #cloud #devops

@marknca tweeted at 18-Nov-2021, 18:02

Tweet 9/9 👇 Next tweet 👆 Start

if you're building out APIs using @awscloud API Gateway (even if they are internal-only), this project should help you document those APIs & provision access check it out at https://github.com/awslabs/aws-api-gateway-developer-portal /🧵☁️ #cloud #devops

@marknca tweeted at 18-Nov-2021, 18:02

👆 Start

Share Tweet Share Share Email

Read next