vikarti.anatra/polaris-mirror
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Utoipa collection endpoints

Browse source
This commit is contained in:
Antoine Gersant 2025-01-14 22:53:19 -08:00
parent 07e8077a38
commit 350557785c
2 changed files with 105 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

108
src/server/axum/api.rs
View file

@ -44,17 +44,17 @@ pub fn router() -> OpenApiRouter<App> {
.routes(routes!(get_flatten_root)) .routes(routes!(get_flatten_root))
.routes(routes!(get_flatten)) .routes(routes!(get_flatten))
// Semantic // Semantic
.route("/albums", get(get_albums)) .routes(routes!(get_albums))
.route("/albums/recent", get(get_recent_albums)) .routes(routes!(get_recent_albums))
.route("/albums/random", get(get_random_albums)) .routes(routes!(get_random_albums))
.route("/artists", get(get_artists)) .routes(routes!(get_artists))
.route("/artists/{artist}", get(get_artist)) .routes(routes!(get_artist))
.route("/artists/{artists}/albums/{name}", get(get_album)) .routes(routes!(get_album))
.route("/genres", get(get_genres)) .routes(routes!(get_genres))
.route("/genres/{genre}", get(get_genre)) .routes(routes!(get_genre))
.route("/genres/{genre}/albums", get(get_genre_albums)) .routes(routes!(get_genre_albums))
.route("/genres/{genre}/artists", get(get_genre_artists)) .routes(routes!(get_genre_artists))
.route("/genres/{genre}/songs", get(get_genre_songs)) .routes(routes!(get_genre_songs))
.route("/random", get(get_random_albums)) // Deprecated .route("/random", get(get_random_albums)) // Deprecated
.route("/recent", get(get_recent_albums)) // Deprecated .route("/recent", get(get_recent_albums)) // Deprecated
// Search // Search
@ -492,6 +492,13 @@ async fn get_flatten(
song_list_to_response(song_list, api_version) song_list_to_response(song_list, api_version)
} }
#[utoipa::path(
get,
path = "/albums",
responses(
(status = 200, body = Vec<dto::AlbumHeader>),
)
)]
async fn get_albums( async fn get_albums(
_auth: Auth, _auth: Auth,
State(index_manager): State<index::Manager>, State(index_manager): State<index::Manager>,
@ -507,6 +514,13 @@ async fn get_albums(
)) ))
} }
#[utoipa::path(
get,
path = "/artists",
responses(
(status = 200, body = Vec<dto::ArtistHeader>),
)
)]
async fn get_artists( async fn get_artists(
_auth: Auth, _auth: Auth,
State(index_manager): State<index::Manager>, State(index_manager): State<index::Manager>,
@ -522,6 +536,14 @@ async fn get_artists(
)) ))
} }
#[utoipa::path(
get,
path = "/artists/{artist}",
params(("artist" = String, Path)),
responses(
(status = 200, body = dto::Artist),
)
)]
async fn get_artist( async fn get_artist(
_auth: Auth, _auth: Auth,
State(index_manager): State<index::Manager>, State(index_manager): State<index::Manager>,
@ -530,6 +552,17 @@ async fn get_artist(
Ok(Json(index_manager.get_artist(artist).await?.into())) Ok(Json(index_manager.get_artist(artist).await?.into()))
} }
#[utoipa::path(
get,
path = "/artists/{artists}/albums/{album}",
params(
("artists" = String, Path),
("album" = String, Path),
),
responses(
(status = 200, body = dto::Album),
)
)]
async fn get_album( async fn get_album(
_auth: Auth, _auth: Auth,
State(index_manager): State<index::Manager>, State(index_manager): State<index::Manager>,
@ -575,6 +608,13 @@ async fn get_peaks(
Ok(peaks.interleaved) Ok(peaks.interleaved)
} }
#[utoipa::path(
get,
path = "/albums/random",
responses(
(status = 200, body = Vec<dto::AlbumHeader>),
)
)]
async fn get_random_albums( async fn get_random_albums(
_auth: Auth, _auth: Auth,
api_version: APIMajorVersion, api_version: APIMajorVersion,
@ -593,6 +633,13 @@ async fn get_random_albums(
albums_to_response(albums, api_version) albums_to_response(albums, api_version)
} }
#[utoipa::path(
get,
path = "/albums/recent",
responses(
(status = 200, body = Vec<dto::AlbumHeader>),
)
)]
async fn get_recent_albums( async fn get_recent_albums(
_auth: Auth, _auth: Auth,
api_version: APIMajorVersion, api_version: APIMajorVersion,
@ -608,6 +655,13 @@ async fn get_recent_albums(
albums_to_response(albums, api_version) albums_to_response(albums, api_version)
} }
#[utoipa::path(
get,
path = "/genres",
responses(
(status = 200, body = Vec<dto::GenreHeader>),
)
)]
async fn get_genres( async fn get_genres(
_auth: Auth, _auth: Auth,
State(index_manager): State<index::Manager>, State(index_manager): State<index::Manager>,
@ -622,6 +676,14 @@ async fn get_genres(
)) ))
} }
#[utoipa::path(
get,
path = "/genres/{genre}",
params(("genre" = String, Path)),
responses(
(status = 200, body = Vec<dto::Genre>),
)
)]
async fn get_genre( async fn get_genre(
_auth: Auth, _auth: Auth,
State(index_manager): State<index::Manager>, State(index_manager): State<index::Manager>,
@ -630,6 +692,14 @@ async fn get_genre(
Ok(Json(index_manager.get_genre(genre).await?.into())) Ok(Json(index_manager.get_genre(genre).await?.into()))
} }
#[utoipa::path(
get,
path = "/genres/{genre}/albums",
params(("genre" = String, Path)),
responses(
(status = 200, body = Vec<dto::AlbumHeader>),
)
)]
async fn get_genre_albums( async fn get_genre_albums(
_auth: Auth, _auth: Auth,
State(index_manager): State<index::Manager>, State(index_manager): State<index::Manager>,
@ -645,6 +715,14 @@ async fn get_genre_albums(
Ok(Json(albums)) Ok(Json(albums))
} }
#[utoipa::path(
get,
path = "/genres/{genre}/artists",
params(("genre" = String, Path)),
responses(
(status = 200, body = Vec<dto::ArtistHeader>),
)
)]
async fn get_genre_artists( async fn get_genre_artists(
_auth: Auth, _auth: Auth,
State(index_manager): State<index::Manager>, State(index_manager): State<index::Manager>,
@ -660,6 +738,14 @@ async fn get_genre_artists(
Ok(Json(artists)) Ok(Json(artists))
} }
#[utoipa::path(
get,
path = "/genres/{genre}/songs",
params(("genre" = String, Path)),
responses(
(status = 200, body = dto::SongList),
)
)]
async fn get_genre_songs( async fn get_genre_songs(
_auth: Auth, _auth: Auth,
State(index_manager): State<index::Manager>, State(index_manager): State<index::Manager>,

16
src/server/dto/v8.rs
View file

@ -297,7 +297,7 @@ impl From<index::File> for BrowserEntry {
} }
} }
#[derive(Debug, PartialEq, Eq, Serialize, Deserialize)] #[derive(Debug, PartialEq, Eq, Serialize, Deserialize, ToSchema)]
pub struct GenreHeader { pub struct GenreHeader {
pub name: String, pub name: String,
} }
@ -310,7 +310,7 @@ impl From<index::GenreHeader> for GenreHeader {
} }
} }
#[derive(Debug, PartialEq, Eq, Serialize, Deserialize)] #[derive(Debug, PartialEq, Eq, Serialize, Deserialize, ToSchema)]
pub struct Genre { pub struct Genre {
#[serde(flatten)] #[serde(flatten)]
pub header: GenreHeader, pub header: GenreHeader,
@ -355,7 +355,7 @@ impl From<index::Genre> for Genre {
} }
} }
#[derive(Debug, PartialEq, Eq, Serialize, Deserialize)] #[derive(Debug, PartialEq, Eq, Serialize, Deserialize, ToSchema)]
pub struct ArtistHeader { pub struct ArtistHeader {
pub name: String, pub name: String,
pub num_albums_as_performer: u32, pub num_albums_as_performer: u32,
@ -380,21 +380,21 @@ impl From<index::ArtistHeader> for ArtistHeader {
} }
} }
#[derive(Debug, PartialEq, Eq, Serialize, Deserialize)] #[derive(Debug, PartialEq, Eq, Serialize, Deserialize, ToSchema)]
pub struct Artist { pub struct Artist {
#[serde(flatten)] #[serde(flatten)]
pub header: ArtistHeader, pub header: ArtistHeader,
pub albums: Vec<ArtistAlbum>, pub albums: Vec<ArtistAlbum>,
} }
#[derive(Debug, PartialEq, Eq, Serialize, Deserialize)] #[derive(Debug, PartialEq, Eq, Serialize, Deserialize, ToSchema)]
pub struct ArtistAlbum { pub struct ArtistAlbum {
#[serde(flatten)] #[serde(flatten)]
pub album: AlbumHeader, pub album: AlbumHeader,
pub contributions: Vec<Contribution>, pub contributions: Vec<Contribution>,
} }
#[derive(Debug, PartialEq, Eq, Serialize, Deserialize)] #[derive(Debug, PartialEq, Eq, Serialize, Deserialize, ToSchema)]
pub struct Contribution { pub struct Contribution {
pub performer: bool, pub performer: bool,
pub composer: bool, pub composer: bool,
@ -424,7 +424,7 @@ impl From<index::Artist> for Artist {
} }
} }
#[derive(Debug, PartialEq, Eq, Serialize, Deserialize)] #[derive(Debug, PartialEq, Eq, Serialize, Deserialize, ToSchema)]
pub struct AlbumHeader { pub struct AlbumHeader {
pub name: String, pub name: String,
#[serde(default, skip_serializing_if = "Option::is_none")] #[serde(default, skip_serializing_if = "Option::is_none")]
@ -446,7 +446,7 @@ impl From<index::AlbumHeader> for AlbumHeader {
} }
} }
#[derive(Debug, PartialEq, Eq, Serialize, Deserialize)] #[derive(Debug, PartialEq, Eq, Serialize, Deserialize, ToSchema)]
pub struct Album { pub struct Album {
#[serde(flatten)] #[serde(flatten)]
pub header: AlbumHeader, pub header: AlbumHeader,