Skip to content

[I Made This]: Serverless API Documentation with Powertools for AWS #3798

Closed
@ran-isenberg

Description

@ran-isenberg

Link to your material

https://www.ranthebuilder.cloud/post/serverless-open-api-documentation-with-aws-powertools

Description

High-quality API documentation enhances customer satisfaction, especially in the serverless architecture, where Lambda functions serve the API. Documenting these APIs has always felt like writing a novel with a feathered pen. At least, they did until now, when Powertools for AWS released its OpenAPI documentation utility.

This post presents a method to generate OpenAPI documentation for Python Lambda function-based APIs, utilizing Powertools for AWS Lambda and Pydantic.

In the next post, we will discuss automating this process and adding it to the service CI/CD pipeline as a gate to production and publishing the documentation.

Preferred contact

Ran Isenberg

(Optional) Social Network

No response

(Optional) Additional notes

see PR

Acknowledgment

  • I understand this content may be removed from Powertools for AWS Lambda (Python) documentation if it doesn't conform with the Code of Conduct

Metadata

Metadata

Assignees

Labels

community-contentCommunity content to feature in the documentation

Type

No type

Projects

Status

Shipped

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions