/rust_service_template

Primary LanguageRustMIT LicenseMIT

Rust Service Template

This is a project template for HTTP services. It aims to get you up and running with features expected on more opinionated web frameworks while you can keep control of the specific pieces.

How to use this template

  • Be sure that you have cargo generate installed.
  • Run the following command:
cargo generate dbofmmbt/rust_service_template

Features checklist

Ready

  • Logs
    • tracing + opentelemetry
  • Health check
    • Simple /health endpoint
  • Trace Context extraction
    • axum_tracing_opentelemetry and opentelemetry propagators did it.
  • Config through e.g. yaml or TOML and env vars override
    • Using config for that
  • Basic setup for service/integration tests
    • using wiremock
  • Dockerfile
  • Configured HTTP client
    • request and response tracing
    • Trace Context propagation

TODO

  • Use Docker's buildkit to cache dependencies
  • Evaluate addition of the http_problem crate, or something similar
  • Add endpoint to print information similar to actuator info
  • Evaluate crates that generate OpenAPI schemas