feat(event-handler): add compress option when serving Swagger HTML

[xquek]

Issue number: #3935

Summary

Changes

Added option to compress response for swagger UI page.

User experience

from aws_lambda_powertools import Logger, Tracer
from aws_lambda_powertools.event_handler import APIGatewayRestResolver
from aws_lambda_powertools.utilities.typing import LambdaContext

tracer = Tracer()
logger = Logger()
app = APIGatewayRestResolver(enable_validation=True)
app.enable_swagger(path="/swagger", compress=True)  


@app.get("/todos")
def get_todos():
    return {"todos": "todos"}


def lambda_handler(event: dict, context: LambdaContext) -> dict:
    return app.resolve(event, context)

Checklist

If your change doesn't seem to apply, please leave them unchecked.

• Meet tenets criteria
• I have performed a self-review of this change
• Changes have been tested
• Changes are documented ( i have document this option in the docstring, i am not sure if this needs to be added to the README.md as well)
• PR title follows conventional commit semantics

Is this a breaking change?

No this is not a breaking change as the default is set to false (current behaviour) **RFC issue number**:

Checklist:

• Migration process documented
• Implement warnings (if it can live side by side)

Acknowledgment

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

[boring-cyborg]

Thanks a lot for your first contribution! Please check out our contributing guidelines and don't hesitate to ask whatever you need.
In the meantime, check out the #python channel on our Powertools for AWS Lambda Discord: Invite link

[xquek]

hi i didnt add any notes aws_lambda_powertools/event_handler/api_gateway.py let me know if i should! thank you!

Also looks like sonar is failing with too many parameters for the enable_swagger function. let me know if there is something that you will like me change

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.33%. Comparing base (e14e768) to head (1544951).
Report is 169 commits behind head on develop.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #3946      +/-   ##
===========================================
- Coverage    96.38%   96.33%   -0.05%     
===========================================
  Files          214      215       +1     
  Lines        10030    10251     +221     
  Branches      1846     1913      +67     
===========================================
+ Hits          9667     9875     +208     
- Misses         259      269      +10     
- Partials       104      107       +3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
1 Accepted issue

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

[leandrodamascena]

@rubenfonseca I need your review here, please.

[leandrodamascena]

hi i didnt add any notes aws_lambda_powertools/event_handler/api_gateway.py let me know if i should! thank you!

Also looks like sonar is failing with too many parameters for the enable_swagger function. let me know if there is something that you will like me change

Hi @xquek! Yes, Sonar was complaining about too many parameters, but I marked it as "Will not fix" because we have nothing to do.
Thanks for working on this. I added some information in our documentation to help others with the same problem you had.

[boring-cyborg]

Awesome work, congrats on your first merged pull request and thank you for helping improve everyone's experience!