sbol-db-server 0.1.7

HTTP server for sbol-db.
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

//! The idiomatic SynBioHub v2 REST adapter, mounted under `/api/v2`.
//!
//! SynBioHub v2 is the RESTful presentation of the SynBioHub product surface.
//! It uses the same [`AppServices`](sbol_db_app::AppServices) facade as the
//! SynBioHub v1 compatibility adapter and holds no business logic of its own.
//! Every handler calls the same facade verbs as the v1 adapter and differs only
//! in wire shape: proper HTTP verbs, JSON request and response bodies, real
//! pagination with a total, `Accept`-driven content negotiation, a single
//! consistent [`V2Error`] envelope, and bearer or same-origin browser session
//! auth. It is ACL-scoped and identity-aware through the same
//! [`GraphScope`](sbol_db_sparql::GraphScope) and account as the v1 adapter.

mod account;
mod admin;
pub(crate) mod auth;
mod collaboration;
mod collections;
mod docs;
mod download;
mod error;
mod instance;
mod negotiate;
mod objects;
mod reviews;
mod search;
mod sequence;
mod session;
mod util;

use axum::routing::{delete, get, post, put};
use axum::{Json, Router};
use serde_json::{json, Value};

use crate::AppState;

/// The SynBioHub v2 router: identity middleware wrapping the product routes.
/// Mounted by [`crate::router`] under `/api/v2`, inheriting the server's metrics,
/// body-limit, and timeout layers.
///
/// Every route delegates to the same `sbol-db-app` facade verbs the SynBioHub v1
/// adapter calls; v2 differs only in wire shape (proper HTTP verbs, JSON bodies, real
/// pagination, `Accept` negotiation, a consistent error envelope, and bearer
/// or same-origin browser-session auth).
pub fn router(state: AppState) -> Router<AppState> {
    Router::new()
        .route("/", get(version))
        .route("/instance", get(instance::get))
        .route(
            "/session",
            get(session::get)
                .post(session::create)
                .delete(session::delete),
        )
        .route("/account", get(account::get).patch(account::patch))
        .route("/account/password", post(account::change_password))
        .route("/account/shared", get(account::shared))
        .nest("/admin", admin::router())
        .route("/reviews", get(reviews::list))
        .route("/openapi.json", get(docs::openapi_json))
        .route("/docs", get(docs::docs_html))
        .route("/collections", post(collections::create_collection))
        .route(
            "/collections/validate",
            post(collections::validate_collection),
        )
        .route("/collections/:iri/members", post(collections::add_member))
        .route("/collections/:iri", delete(collections::delete_collection))
        .route(
            "/collections/:iri/members/:member",
            delete(collections::remove_member),
        )
        .route("/objects", get(objects::list_objects))
        .route(
            "/objects/:iri",
            get(objects::get_object)
                .patch(objects::patch_object)
                .delete(objects::delete_object),
        )
        .route("/objects/:iri/details", get(objects::get_object_details))
        .route("/objects/:iri/activity", get(reviews::activity))
        .route(
            "/objects/:iri/reviews",
            get(reviews::get).post(reviews::request),
        )
        .route("/objects/:iri/reviews/decision", post(reviews::decide))
        .route(
            "/objects/:iri/shares",
            get(collaboration::list).post(collaboration::grant),
        )
        .route("/objects/:iri/shares/:user", delete(collaboration::revoke))
        .route("/objects/:iri/owner", put(collaboration::transfer))
        .route("/objects/:iri/publish", post(objects::publish_object))
        .route("/objects/:iri/similar", get(sequence::similar))
        .route(
            "/search",
            get(search::search).post(search::structured_search),
        )
        .route("/search/facets", get(search::facets))
        .route("/search/strategies", get(search::strategies))
        .route("/sequences/search", get(sequence::search_sequences))
        .route_layer(axum::middleware::from_fn_with_state(
            state,
            auth::attach_identity,
        ))
}

/// `GET /api/v2` — the version and identity probe. Unauthenticated; serves as
/// the surface's health endpoint.
async fn version() -> Json<Value> {
    Json(json!({
        "name": "sbol-db",
        "api": "v2",
        "version": env!("CARGO_PKG_VERSION"),
    }))
}