Skip to content

Architecture

Application

The application is created completely serverless and well-architected. It follows the AWS best-practices.

TODO: Detailed explanation

Diagram

Architetcure

Documentation

The documentation of the application is automatically created and deployed.

Application

The application documentation is created with mkdocs and mkdocstrings. It's a combination of static markdown and dynamically created from the python code. The documentation is served as static content from a S3 bucket via a Cloudfront Distribution.

TODO: Architecture Image

API

The API documentation is served via the API Gateway. It's build on a modified version of aws-serverless-swagger-ui.
The core component is a Lambda function which is the target for a proxy endpoint in the API Gateway. When the page is accesses, it fetches the swagger file directly from the API Gateway and serves the static swagger ui. To access the page, a valid token from the cognito user pool is needed.

TODO: Architecture Image

https://github.com/mkdocstrings/mkdocstrings
https://chrieke.medium.com/documenting-a-python-package-with-code-reference-via-mkdocs-material-b4a45197f95b
https://github.com/sylwit/aws-serverless-swagger-ui