Feature request: Add ability to download OpenAPI spec

[Thomas-McKanna]

Use case

The Swagger UI feature is nice, but it would be even better to be able to download the OpenAPI specification file so that if users would like to render the documentation in alternative formats, they are easily able to do so.

Solution/User Experience

This could be achieved by adding another endpoint when Swagger is enabled at /swagger.json which would download the spec file.

Alternative solutions

No response

Acknowledgment

• This feature request meets Powertools for AWS Lambda (Python) Tenets
• Should this be considered in other Powertools for AWS Lambda languages? i.e. Java, TypeScript, and .NET

[leandrodamascena]

Hi @Thomas-McKanna! Thanks for the feedback on this feature, we launched it weeks ago and this kind of feedback helps us understand what is still missing in this new utility.

To allow the customer download the OpenAPI definition we must use the url parameter instead of using spec parameter when configuring SwaggerUI, and today we generate the spec on-the-fly using the spec field.

It will be possible if we create a new endpoint for /swagger.json (for example) and add a flag to let the customer decide whether or not to enable this endpoint when enabling swagger.

I believe this is a great improvement on the OpenAPI feature. We will be very happy if you want to work on this and send a PR as a contribution.

Thanks

[Thomas-McKanna]

@leandrodamascena Sounds good. I will work on a PR.

[Thomas-McKanna]

PR created: #3571

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

This issue is now closed. Please be mindful that future comments are hard for our team to see.

If you need more assistance, please either tag a team member or open a new issue that references this one.

If you wish to keep having a conversation with other community members under this issue feel free to do so.