henning
dec8face54
Implements a first vertical slice of the Outline RPC API (auth, documents, collections, users) covering the structural patterns used across the whole API: single object, paginated list, tree, create/update, delete, search. Chosen as the basis for future CLI and GUI clients built on top of this crate. - Handwritten client (not codegen) against the vendored OpenAPI spec, since Outline's API is uniformly POST /api/<resource>.<action> with JSON bodies and inline/anonymous schemas that generators handle poorly - Async (reqwest + tokio) Client, cheaply cloneable, no &mut self methods - thiserror-based Error with ErrorKind classification and boxed API error context; forward-compatible models (unknown fields ignored, unknown string-enum values preserved via a catch-all variant) since the API is unversioned and self-hosted instances vary in age - Pagination via Page<T>/Paginator with next_page/collect_all/into_stream - wiremock-based test suite plus a spec-coverage test guarding against typos in RPC method names
12 lines
329 B
Rust
12 lines
329 B
Rust
use outline::Client;
|
|
use wiremock::MockServer;
|
|
|
|
/// Spins up a mock Outline API server and a [`Client`] pointed at it.
|
|
pub async fn client_for(server: &MockServer) -> Client {
|
|
Client::builder()
|
|
.base_url(server.uri())
|
|
.api_key("ol_api_test000000000000000000000000000000")
|
|
.build()
|
|
.unwrap()
|
|
}
|