search

awslabs / aws-api-gateway-developer-portal

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

Provide an option to view API documentation without auth requirement #351

Open NutterzUK opened 4 years ago

NutterzUK commented 4 years ago

As a developer looking to use an API When I land on the developer portal I would like to be able to review the API documentation before registering So that I can decide if the API is what I am looking for.

Actual: I am presented with a screen that says "Your administrator hasn't added any APIs to your account. Please contact them to publish an API."

There are two problems here: 1- The user doesn't have an account and so this is an odd message to give the user. 2- I'd like to see the API documentation.

Expected: When launching the developer portal, I can specify if I would like the documentation to be public or not. OR, alternatively, this can be managed on a per-api basis.

Potential fix (Though I am new to this codebase): Make this conditional: https://github.com/awslabs/aws-api-gateway-developer-portal/blob/7dfea1207636c72df09ca864855c4d809587e6ab/cloudformation/template.yaml#L303

steve-be-old commented 4 years ago

I would like this as well. Is there a suggested code change I could make in the REACT app to allow this?

gmmarc commented 3 years ago

I'm also interested in this. Did you find a solution?