Application Examples
This page provides an overview of the example applications available in the project. These examples demonstrate various features of the Mitsuki framework.
Blog App
The blog_app example is a simple blogging application that demonstrates core concepts such as controllers, services, repositories, and more.
OpenAPI
The openapi example shows how to generate OpenAPI documentation for your application. This is useful for creating interactive API documentation and for sharing your API specification with other developers.
Scheduled Tasks
The scheduled example demonstrates how to run tasks at a specified interval. This is useful for background jobs, such as sending emails or cleaning up old data.
Instrumentation
The instrumentation_demo example shows Mitsuki's instrumentation and metrics with a single @Instrumented decorator: system, HTTP, component, scheduler and custom metrics, exported in Prometheus format and visualized in pre-configured Grafana dashboards. Run it with Docker Compose to bring up the app, Prometheus and Grafana together.
Transactions
The transactions example is a small ledger API: transfers between accounts run in one transaction with @Transactional, an audit log is written with REQUIRES_NEW so failed attempts are kept, and a batch of transfers uses NESTED savepoints to skip the ones that fail. It runs against PostgreSQL started with Docker Compose.