Feature request: API Swagger documentation generator

[ran-isenberg]

Use case

I'd like to generate swagger JSON files describing my service out of my lambda handlers functions.
I've seen utilities such as FasTAPI do that but I want a more simplified and native lambda experience.

Solution/User Experience

A simple decorator is added to the function handler. In runtime it will not do anything and will not impact performance.
However, the utility will supply a CLI command that will generate the JSON output file so it can be committed into the repository.

Similar to FastAPI it can supports the following arguments:

1. general description
2. path parameters description
3. Pydantic body schema support
4. response codes
5. query parameters support

We can create a wrapper around FastAPI or write it from scratch.

Alternative solutions

No response

Acknowledgment

• This feature request meets Lambda Powertools Tenets
• Should this be considered in other Lambda Powertools languages? i.e. Java, TypeScript

[leandrodamascena]

Hi @ran-isenberg! Thank you for opening this issue. I'm moving this topic to "On Hold" because I know @heitorlessa wants to get some ideas on this and he is out this week.

Thank you.

[pharindoko]

@ran-isenberg this issue already describes it #1236

[heitorlessa]

hey Ran, I'm closing this in favour of generating it at runtime with a new route (Swagger UI + OpenAPI generated for you): #2421

It'd be great to get your feedback from a Pydantic customer perspective - I suspect we might need a new Event Handler implementation altogether to make Pydantic a first class citizen like FastAPI.

#2421

[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.