rust-microservice 0.1.3

A microservices framework in Rust whichs provides common functionalities for developing Web APIs.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

---

## [0.1.3] - Offline Swagger UI via vendored utoipa-swagger-ui

### Changed

- Enabled the `vendored` feature on the `utoipa-swagger-ui` dependency on crate `cargo.toml`
  and `cargo.toml` in `examples/server`.

## [0.1.2] - Offline Swagger UI via vendored utoipa-swagger-ui

### Changed

- Enabled the `vendored` feature on the `utoipa-swagger-ui` dependency, bundling all Swagger UI 
  static assets directly into the compiled binary. This removes the runtime dependency on an 
  external CDN, allowing the interactive API documentation to load fully offline and in 
  restricted-network environments.

## [0.1.1] - Publish a new version to crates.io

### Changed

- Corrected the macro crate documentation and published a new version to `crates.io`.

## [0.1.0] - Initial Release

### Added

#### Configuration & Core Server
- YAML-based configuration via `config.yaml`;
- Built-in API documentation with OpenAPI and interactive UI through Swagger UI powered by Utoipa Swagger UI;
- Built-in Health Check endpoint;
- Configurable server and actuator ports (defaults: `8080` and `7188`);
- Built-in CORS configuration support;
- MVC-based project architecture;
- Built-in metrics export compatible with Prometheus;
- Automatic database connectivity (SQLite, PostgreSQL, MySQL, and Google BigQuery) driven by YAML configuration;
- Local development and integration testing with Docker Compose and Testcontainers;
- Custom dashboard panel for metrics visualization in Grafana;
- CI/CD pipeline configured in GitLab;
- Integration test wrapper for initializing a global Testcontainers environment;
- Static code analysis via SonarQube;
- Multi-stage containerization: a slim image based on `BusyBox` with UPX compression, and a full-featured image based on `Alpine Linux` including network tools and the Nano editor.

#### Development Environment (example project)
- Docker Compose file to start the CI/CD environment containers: GitLab, GitLab Runner, Nexus Repository, and SonarQube;
- Docker Compose file to start runtime service containers: Keycloak, PostgreSQL, Mailpit, Grafana, Grafana Tempo, Prometheus, and Loki used during server execution;
- GitLab Runner configuration for integration with the Server project pipeline;
- Local Kubernetes setup using `K3D`;
- Kubernetes configuration manifest for the example Server project;
- Integration settings for the example Server project with SonarQube (`sonar-project.properties`).

#### Security
- Built-in integration with OAuth2 servers (Keycloak on the server example);
- Automatic discovery URL resolution for:
  issuer, jwks, token, authorization, introspection, user-info, and end-session endpoints;
- Endpoint-level security configuration using Rust macros.

Example:

```rust
#[utoipa::path(
    post,
    path = "/v1/user",
    tag = "Endpoint for creating a new user",
    responses(
        (status = 200, description= "The data structure representing a newly created user.", body = UserDTO),
        (status = 400, description= "The data structure representing an error message.", body = ResponseDTO),
    )
)]
#[secured(method = "post", path = "/v1/user", authorize = "ROLE_ADMIN")]
pub async fn create_user_endpoint(user: web::Json<UserDTO>) -> HttpResponse {
  ...
}