search

awslabs / aws-api-gateway-developer-portal

A Serverless Developer Portal for easily publishing and cataloging APIs
Apache License 2.0
930 stars 401 forks source link

Custom API Icon With Imported APIs #342

Closed snowake4me closed 4 years ago

snowake4me commented 4 years ago

Kind Devs-

First off - HUGE shout out of appreciation for this project. Our company is poised to spend a ton of money on a competing API Gateway product, largely because of it's Developer Portal capability -- and this product has really continued to evolve and mature since we first explored it 18 months or so ago.

It was easy enough to deploy, and following the information in the Customization wiki page, we were quickly / easily able to replace many of the static assets: favicon.ico, home-image.png, nav-logo.png, etc.

Until we get to the API-specific logos. I really, REALLY banged my head with this: Tried every value imaginable for {apiId} (API ID), even though that should be a discrete / unique value (but another ID is generated with each Stage deployment - so I tried a bunch of those, as well).

Finally, inspecting the file used to import the API (whether Swagger or OpenAPI 3 format), I see that, regardless of what it might be called - the API ID does not appear in the export -- so, it seems that there could be no way for the Developer Portal to properly detect and associate the custom image uploaded to the S3 bucket.

Is it an accurate statement / assumption, that only APIs published to a stage in API Gateway in the current account (Where the API Gateway Developer Portal is deployed) are able to have custom icons, as documented in the Customization wiki page here?

https://github.com/awslabs/aws-api-gateway-developer-portal/wiki/Customization

I've opened a support case with AWS, escalated to our TAM, and am hoping to get connected with the product team -- but then decided this was probably the shortest path to same.

Thanks in advance for any guidance or ProTips -- and thanks again for creating, and enhancing this product. It's a very valuable addition to API Gateway for our organization!

snowake4me commented 4 years ago

Team / Community: Working with AWS Support, I was able to learn the answer to this question. Ironically, my VERY first guess was SO close -- but missed the mark.

The file naming convention for imported APIs is as follows:

_undefined.png So, for example, when you import an API, and then browse to it -- your URL will look something like this: https://apiportal.example.com/apis/5a758883d7ef8c5b0f9503771040f44b934b075d For this API, name your image: 5a758883d7ef8c5b0f9503771040f44b934b075d_undefined.png And place it in the custom-content/api-logos directory, and... VOILA! Perhaps the Customization guide could be updated to reflect this detail? Closing this issue, as I have the answer I was looking for. Thanks again for this great product!