From 9ff2de36df9b1a70dc69aa9e724ff37192c8d0d4 Mon Sep 17 00:00:00 2001 From: aarbit Date: Tue, 25 Jun 2024 16:12:18 -0500 Subject: [PATCH] Updates readme, adds Swagger doc --- README.md | 11 ++++++++++- build.gradle.kts | 3 ++- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 53fa74a..c2fe621 100644 --- a/README.md +++ b/README.md @@ -5,4 +5,13 @@ Kotlin Spring Boot based REST service for the Pretty Player # Environment Variables * `ALBUM_ROOT_DIR` = Directory where the albums of mp3s can be found -* `ALBUM_ART_ROOT_DIR` = Directory where the album art can be cached for later \ No newline at end of file +* `ALBUM_ART_ROOT_DIR` = Directory where the album art can be cached for later + +# TODO + +* Add in DB like SQLite where the DB can be written to disk easily, and the DB can run in memory. + * Allows for instant ready, while having new albums added async. + +# API Documentation + +* http://localhost:8080/swagger-ui/index.html \ No newline at end of file diff --git a/build.gradle.kts b/build.gradle.kts index 0b0e434..c5bfbef 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -8,7 +8,7 @@ plugins { } group = "net.halfbinary" -version = "0.0.11-SNAPSHOT" +version = "0.0.12-SNAPSHOT" java { sourceCompatibility = JavaVersion.VERSION_21 @@ -44,6 +44,7 @@ dependencies { implementation("org.slf4j:slf4j-api:$slf4jApiVersion") implementation("ch.qos.logback:logback-core:$logbackVersion") implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:$coroutinesVersion") + implementation("org.springdoc:springdoc-openapi-starter-webmvc-ui:2.5.0") developmentOnly("org.springframework.boot:spring-boot-devtools") annotationProcessor("org.springframework.boot:spring-boot-configuration-processor") testImplementation("org.springframework.boot:spring-boot-starter-test")