This template demonstrates building the FastAPI framework for Platform.sh. It includes a minimalist application skeleton that demonstrates how to connect to a MariaDB server for data storage and Redis for caching. The application starts as a bare Python process with no separate runner. It is intended for you to use as a starting point and modify for your own needs.
FastAPI is a modern, fast (high-performance), web framework for building APIs with Python 3.6+ based on standard Python type hints.
- Python 3.9
- MariaDB 10.4
- Redis 5.0
- Automatic TLS certificates
- Pipfile-based build
The following files have been added to a basic FastAPI configuration. If using this project as a reference for your own existing project, replicate the changes below to your project.
- The
.platform.app.yaml,.platform/services.yaml, and.platform/routes.yamlfiles have been added. These provide Platform.sh-specific configuration and are present in all projects on Platform.sh. You may customize them as you see fit. - An additional Pip library,
platformshconfig, has been added. It provides convenience wrappers for accessing the Platform.sh environment variables. - A rudimentary application is included in
server.pyfor demonstration purposes. It shows the basic process of starting the server and connecting to the MariaDB database. Modify and replace it as desired.