socle 3.2.0

Opinionated axum service bootstrap: telemetry, database, rate limiting, and shutdown in one builder
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147

[package]
name = "socle"
version = "3.2.0"
edition = "2024"
authors = ["Gregoire Salingue"]
description = "Opinionated axum service bootstrap: telemetry, database, rate limiting, and shutdown in one builder"
license = "MIT"
repository = "https://github.com/brefwiz/socle"
readme = "README.md"
keywords = ["axum", "tower", "bootstrap", "http", "telemetry"]
categories = ["web-programming::http-server", "asynchronous"]
rust-version = "1.85"

[package.metadata.docs.rs]
# utoipa-swagger-ui downloads assets at build time — blocked by docs.rs sandbox.
# Build docs without the openapi feature to avoid that network dependency.
features = ["telemetry", "database", "ratelimit-memory", "dotenv", "validation", "cursor", "testing"]
no-default-features = true

[features]
default = ["telemetry", "database", "ratelimit-memory", "openapi", "dotenv", "rfc-types"]

dotenv = ["dep:dotenvy"]

# Enforce RFC-oriented api-bones response types at compile time.
# When enabled (the default), handler success responses must be constructed
# via the socle builder functions (ok, created, created_at, created_under,
# listed, listed_page, etagged).  Direct tuple construction of Ok arms is
# rejected by the compiler.  Disable only during a migration window; document
# the reason.  Use UnconstrainedResponse for per-handler opt-outs instead.
rfc-types = []

telemetry = []

database = ["dep:sqlx"]

ratelimit = []
ratelimit-memory = ["ratelimit", "dep:governor"]

nats = ["dep:async-nats", "dep:metrics-api"]
test-util = []

openapi = ["dep:utoipa", "dep:utoipa-swagger-ui"]

validation = ["dep:validator"]

cursor = ["api-bones/base64"]

testing = ["dep:reqwest"]
http-client = ["dep:reqwest", "dep:reqwest-middleware", "dep:opentelemetry", "dep:async-trait", "dep:http"]
metrics = ["dep:opentelemetry", "dep:opentelemetry_sdk", "dep:opentelemetry-prometheus", "dep:prometheus"]
testing-postgres = ["dep:testcontainers", "dep:testcontainers-modules", "dep:sqlx"]

[dependencies]
axum = { version = "0.8", features = ["macros"] }
tokio = { version = "1", features = ["full"] }
tower = { version = "0.5", features = ["util"] }
tower-http = { version = "0.6", features = ["trace", "cors", "catch-panic", "compression-full", "request-id", "util", "limit"] }
uuid = { version = "1", features = ["v7", "v5"] }
futures-util = "0.3"
tracing = "0.1"
tracing-subscriber = { version = "0.3", features = ["env-filter", "json"] }
thiserror = "2"
serde = { version = "1", features = ["derive"] }
serde_json = "1"
figment = { version = "0.10", features = ["env", "toml"] }
chrono = { version = "0.4", features = ["serde"] }

api-bones = { version = "=4.7.0", features = ["axum", "uuid"] }

sqlx = { version = "0.8", default-features = false, features = ["runtime-tokio-rustls", "postgres", "migrate"], optional = true }

governor = { version = "0.10", default-features = false, features = ["std", "dashmap"], optional = true }

utoipa = { version = "5", optional = true }
utoipa-swagger-ui = { version = "9", default-features = false, features = ["axum", "vendored"], optional = true }

dotenvy = { version = "0.15", optional = true }

reqwest = { version = "0.13", default-features = false, features = ["json", "rustls"], optional = true }
reqwest-middleware = { version = "0.5", optional = true }
opentelemetry = { version = "0.31", optional = true }
async-trait = { version = "0.1", optional = true }
http = { version = "1", optional = true }
opentelemetry_sdk = { version = "0.31", default-features = false, features = ["metrics"], optional = true }
opentelemetry-prometheus = { version = "0.31", optional = true }
prometheus = { version = "0.14", default-features = false, optional = true }

validator = { version = "0.20", features = ["derive"], optional = true }

testcontainers = { version = "0.27", optional = true }
testcontainers-modules = { version = "0.15", features = ["postgres"], optional = true }

async-nats = { version = "0.47", optional = true }
metrics-api = { package = "metrics", version = "0.23", optional = true }

[dev-dependencies]
tokio = { version = "1", features = ["full", "test-util"] }
reqwest = { version = "0.13", default-features = false, features = ["json", "rustls"] }
serde_json = "1"
http-body-util = "0.1"
bytes = "1"
tempfile = "3"
sqlx = { version = "0.8", default-features = false, features = ["runtime-tokio-rustls", "postgres"] }
opentelemetry_sdk = { version = "0.31", features = ["trace"] }

[[example]]
name = "minimal"
path = "examples/minimal.rs"
required-features = ["telemetry"]

[[example]]
name = "with_database"
path = "examples/with_database.rs"
required-features = ["telemetry", "database"]

[[example]]
name = "with_ratelimit"
path = "examples/with_ratelimit.rs"
required-features = ["telemetry", "ratelimit-memory"]

[[test]]
name = "integration"
path = "tests/integration.rs"
required-features = ["testing"]

[[test]]
name = "org_isolation"
path = "tests/org_isolation.rs"

[[test]]
name = "org_policy"
path = "tests/org_policy.rs"

[[test]]
name = "audit_filter"
path = "tests/audit_filter.rs"

[[test]]
name = "audit_layer"
path = "tests/audit_layer.rs"
required-features = ["test-util"]

[[test]]
name = "audit_sinks"
path = "tests/audit_sinks.rs"
required-features = ["test-util"]