From a6ee466b8d288339bf075a943a5fdeae9c2e2e3c Mon Sep 17 00:00:00 2001 From: juli0n21 Date: Wed, 5 Feb 2025 01:43:13 +0100 Subject: [PATCH] add swagger docs --- go-backend/go.mod | 5 +- go-backend/go.sum | 22 ++-- go-backend/handlers.go | 254 ++++++++++++++++++++++------------------- 3 files changed, 150 insertions(+), 131 deletions(-) diff --git a/go-backend/go.mod b/go-backend/go.mod index 3e13adb..98612ab 100644 --- a/go-backend/go.mod +++ b/go-backend/go.mod @@ -5,6 +5,8 @@ go 1.23.5 require ( github.com/joho/godotenv v1.5.1 github.com/juli0n21/go-osu-parser v0.0.6 + github.com/swaggo/http-swagger v1.3.4 + github.com/swaggo/swag v1.16.4 modernc.org/sqlite v1.34.5 ) @@ -22,12 +24,9 @@ require ( github.com/ncruces/go-strftime v0.1.9 // indirect github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec // indirect github.com/swaggo/files v1.0.1 // indirect - github.com/swaggo/http-swagger v1.3.4 // indirect - github.com/swaggo/swag v1.16.4 // indirect golang.org/x/net v0.34.0 // indirect golang.org/x/sys v0.29.0 // indirect golang.org/x/tools v0.29.0 // indirect - gopkg.in/yaml.v2 v2.4.0 // indirect gopkg.in/yaml.v3 v3.0.1 // indirect modernc.org/libc v1.55.3 // indirect modernc.org/mathutil v1.6.0 // indirect diff --git a/go-backend/go.sum b/go-backend/go.sum index 187a0ac..995fafa 100644 --- a/go-backend/go.sum +++ b/go-backend/go.sum @@ -1,5 +1,6 @@ github.com/KyleBanks/depth v1.2.1 h1:5h8fQADFrWtarTdtDudMmGsC7GPbOAu6RVB3ffsVFHc= github.com/KyleBanks/depth v1.2.1/go.mod h1:jzSb9d0L43HxTQfT+oSA1EEp2q+ne2uh6XgeJcm8brE= +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/dustin/go-humanize v1.0.1 h1:GzkhY7T5VNhEkwH0PVJgjz+fX1rhBrR7pRT3mDkpeCY= github.com/dustin/go-humanize v1.0.1/go.mod h1:Mu1zIs6XwVuF/gI1OepvI0qD18qycQx+mFykh5fBlto= @@ -21,6 +22,9 @@ github.com/josharian/intern v1.0.0 h1:vlS4z54oSdjm0bgjRigI+G1HpF+tI+9rE5LLzOg8Hm github.com/josharian/intern v1.0.0/go.mod h1:5DoeVV0s6jJacbCEi61lwdGj/aVlrQvzHFFd8Hwg//Y= github.com/juli0n21/go-osu-parser v0.0.6 h1:r5BTNrEDUHsF0ZFCvx0vfRcjU2IRvT3va4O1r3dm7og= github.com/juli0n21/go-osu-parser v0.0.6/go.mod h1:oLLWnZReOMW4i5aNva/zvXsFqzdQigrbjyxOSs0cx+0= +github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE= +github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk= +github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY= github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE= github.com/mailru/easyjson v0.9.0 h1:PrnmzHw7262yW8sTBwxi1PdJA3Iw/EKBa8psRf7d9a4= github.com/mailru/easyjson v0.9.0/go.mod h1:1+xMtQp2MRNVL/V1bOzuP3aP8VNwRW55fQUto+XFtTU= @@ -28,9 +32,14 @@ github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWE github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= github.com/ncruces/go-strftime v0.1.9 h1:bY0MQC28UADQmHmaF5dgpLmImcShSi2kHU9XLdhx/f4= github.com/ncruces/go-strftime v0.1.9/go.mod h1:Fwc5htZGVVkseilnfgOVb9mKy6w1naJmn9CehxcKcls= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec h1:W09IVJc94icq4NjY3clb7Lk8O1qJ8BdBEF8z0ibU0rE= github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec/go.mod h1:qqbHyh8v60DhA7CoWK5oRCqLrMHRGoxYCSS9EjAz6Eo= +github.com/rogpeppe/go-internal v1.11.0 h1:cWPaGQEPrBb5/AsnsZesgZZ9yb1OQ+GOISoDNXVBh4M= +github.com/rogpeppe/go-internal v1.11.0/go.mod h1:ddIwULY96R17DhadqLgMfk9H9tvdUzkipdSkR5nkCZA= +github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg= +github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= github.com/swaggo/files v1.0.1 h1:J1bVJ4XHZNq0I46UU90611i9/YzdrF7x92oX1ig5IdE= github.com/swaggo/files v1.0.1/go.mod h1:0qXmMNH6sXNf+73t65aKeB+ApmgxdnkQzVTAj2uaMUg= github.com/swaggo/http-swagger v1.3.4 h1:q7t/XLx0n15H1Q9/tk3Y9L4n210XzJF5WtnDX64a5ww= @@ -41,9 +50,8 @@ github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5t golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4= -golang.org/x/mod v0.16.0 h1:QX4fJ0Rr5cPQCF7O9lh9Se4pmwfwskqZfq5moyldzic= -golang.org/x/mod v0.16.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c= golang.org/x/mod v0.22.0 h1:D4nJWe9zXqHOmWqj4VMOJhvzj7bEZg4wEYa759z1pH4= +golang.org/x/mod v0.22.0/go.mod h1:6SkKJ3Xj0I0BrPOZoBy3bdMptDDU9oJrpohJ3eWZ1fY= golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c= @@ -52,6 +60,8 @@ golang.org/x/net v0.34.0 h1:Mb7Mrk043xzHgnRM88suvJFwzVrRfHEHJEl5/71CKw0= golang.org/x/net v0.34.0/go.mod h1:di0qlW3YNM5oh6GqDGQr92MyTozJPmybPK4Ev/Gm31k= golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.10.0 h1:3NQrjDixjgGwUOCaF8w2+VYHv0Ve/vGYSbdkTa98gmQ= +golang.org/x/sync v0.10.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk= golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= @@ -59,8 +69,6 @@ golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBc golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.22.0 h1:RI27ohtqKCnwULzJLqkv897zojh5/DwS/ENaMzUOaWI= -golang.org/x/sys v0.22.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= golang.org/x/sys v0.29.0 h1:TPYlXGxvx1MGTn2GiZDhnjPA9wZzZeGKHHmKhHYvgaU= golang.org/x/sys v0.29.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= @@ -73,14 +81,12 @@ golang.org/x/text v0.7.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc= -golang.org/x/tools v0.19.0 h1:tfGCXNR1OsFG+sVdLAitlpjAvD/I6dHDKnYrpEZUHkw= -golang.org/x/tools v0.19.0/go.mod h1:qoJWxmGSIBmAeriMx19ogtrEPrGtDbPK634QFIcLAhc= golang.org/x/tools v0.29.0 h1:Xx0h3TtM9rzQpQuR4dKLrdglAmCEN5Oi+P74JdhdzXE= golang.org/x/tools v0.29.0/go.mod h1:KMQVMRsVxU6nHCFXrBPhDB8XncLNLM0lIy/F14RP588= golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= -gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY= -gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ= +gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk= +gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q= gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= modernc.org/cc/v4 v4.21.4 h1:3Be/Rdo1fpr8GrQ7IVw9OHtplU4gWbb+wNgeoBMmGLQ= diff --git a/go-backend/handlers.go b/go-backend/handlers.go index aafaced..587187f 100644 --- a/go-backend/handlers.go +++ b/go-backend/handlers.go @@ -56,36 +56,39 @@ func run(s *Server) { } // ping godoc -// @Summary Check server health -// @Description Returns a pong response if the server is running -// @Tags health -// @Success 200 {string} string "pong" -// @Router /ping [get] +// +// @Summary Check server health +// @Description Returns a pong response if the server is running +// @Tags health +// @Success 200 {string} string "pong" +// @Router /ping [get] func (s *Server) ping(w http.ResponseWriter, r *http.Request) { fmt.Fprintln(w, "pong") } // login godoc -// @Summary Redirect to login page -// @Description Redirects users to an external authentication page -// @Tags auth -// @Success 307 {string} string "Temporary Redirect" -// @Router /login [get] +// +// @Summary Redirect to login page +// @Description Redirects users to an external authentication page +// @Tags auth +// @Success 307 {string} string "Temporary Redirect" +// @Router /login [get] func (s *Server) login(w http.ResponseWriter, r *http.Request) { http.Redirect(w, r, "https://proxy.illegalesachen.download/login", http.StatusTemporaryRedirect) } // song godoc -// @Summary Get a song by its hash -// @Description Retrieves a song using its unique hash identifier. -// @Tags songs -// @Accept json -// @Produce json -// @Param hash path string true "Song hash" -// @Success 200 {object} Song -// @Failure 400 {string} string "Invalid parameter" -// @Failure 404 {string} string "Song not found" -// @Router /song/{hash} [get] +// +// @Summary Get a song by its hash +// @Description Retrieves a song using its unique hash identifier. +// @Tags songs +// @Accept json +// @Produce json +// @Param hash path string true "Song hash" +// @Success 200 {object} Song +// @Failure 400 {string} string "Invalid parameter" +// @Failure 404 {string} string "Song not found" +// @Router /song/{hash} [get] func (s *Server) song(w http.ResponseWriter, r *http.Request) { hash := r.PathValue("hash") @@ -105,16 +108,17 @@ func (s *Server) song(w http.ResponseWriter, r *http.Request) { } // recents godoc -// @Summary Get a list of recent songs -// @Description Retrieves recent songs with pagination support. -// @Tags songs -// @Accept json -// @Produce json -// @Param limit query int false "Limit" default(10) -// @Param offset query int false "Offset" default(0) -// @Success 200 {array} Song -// @Failure 500 {string} string "Internal server error" -// @Router /songs/recents [get] +// +// @Summary Get a list of recent songs +// @Description Retrieves recent songs with pagination support. +// @Tags songs +// @Accept json +// @Produce json +// @Param limit query int false "Limit" default(10) +// @Param offset query int false "Offset" default(0) +// @Success 200 {array} Song +// @Failure 500 {string} string "Internal server error" +// @Router /songs/recents [get] func (s *Server) recents(w http.ResponseWriter, r *http.Request) { limit, offset := pagination(r) @@ -128,18 +132,19 @@ func (s *Server) recents(w http.ResponseWriter, r *http.Request) { } // favorites godoc -// @Summary Get a list of favorite songs based on a query -// @Description Retrieves favorite songs filtered by a query with pagination support. -// @Tags songs -// @Accept json -// @Produce json -// @Param query query string true "Search query" -// @Param limit query int false "Limit" default(10) -// @Param offset query int false "Offset" default(0) -// @Success 200 {array} Song -// @Failure 400 {string} string "Invalid parameter" -// @Failure 500 {string} string "Internal server error" -// @Router /songs/favorites [get] +// +// @Summary Get a list of favorite songs based on a query +// @Description Retrieves favorite songs filtered by a query with pagination support. +// @Tags songs +// @Accept json +// @Produce json +// @Param query query string true "Search query" +// @Param limit query int false "Limit" default(10) +// @Param offset query int false "Offset" default(0) +// @Success 200 {array} Song +// @Failure 400 {string} string "Invalid parameter" +// @Failure 500 {string} string "Internal server error" +// @Router /songs/favorites [get] func (s *Server) favorites(w http.ResponseWriter, r *http.Request) { query := r.URL.Query().Get("query") if query == "" { @@ -159,16 +164,17 @@ func (s *Server) favorites(w http.ResponseWriter, r *http.Request) { } // collection godoc -// @Summary Get a collection of songs by index -// @Description Retrieves a collection of songs using the provided index. -// @Tags songs -// @Accept json -// @Produce json -// @Param index query int true "Index" -// @Success 200 {array} Song -// @Failure 400 {string} string "Invalid parameter" -// @Failure 500 {string} string "Internal server error" -// @Router /collection [get] +// +// @Summary Get a collection of songs by index +// @Description Retrieves a collection of songs using the provided index. +// @Tags songs +// @Accept json +// @Produce json +// @Param index query int true "Index" +// @Success 200 {array} Song +// @Failure 400 {string} string "Invalid parameter" +// @Failure 500 {string} string "Internal server error" +// @Router /collection [get] func (s *Server) collection(w http.ResponseWriter, r *http.Request) { index, err := strconv.Atoi(r.URL.Query().Get("index")) if err != nil { @@ -176,6 +182,8 @@ func (s *Server) collection(w http.ResponseWriter, r *http.Request) { return } + //TODO + recent, err := getCollection(s.Db, index) if err != nil { http.Error(w, err.Error(), http.StatusInternalServerError) @@ -184,18 +192,18 @@ func (s *Server) collection(w http.ResponseWriter, r *http.Request) { writeJSON(w, recent, http.StatusOK) } -// @Summary Retrieves collections based on a query -// @Description Retrieves collections from the database with pagination based on the query parameter -// @Tags search -// @Accept json -// @Produce json -// @Param query query string false "Search query" -// @Param limit query int false "Limit the number of results" default(10) -// @Param offset query int false "Offset for pagination" default(0) -// @Success 200 {array} Collection "List of collections" -// @Failure 400 {object} string "Bad Request" -// @Failure 500 {object} string "Internal Server Error" -// @Router /collections [get] +// @Summary Retrieves collections based on a query +// @Description Retrieves collections from the database with pagination based on the query parameter +// @Tags search +// @Accept json +// @Produce json +// @Param query query string false "Search query" +// @Param limit query int false "Limit the number of results" default(10) +// @Param offset query int false "Offset for pagination" default(0) +// @Success 200 {array} Collection "List of collections" +// @Failure 400 {object} string "Bad Request" +// @Failure 500 {object} string "Internal Server Error" +// @Router /collections [get] func (s *Server) collections(w http.ResponseWriter, r *http.Request) { query := r.URL.Query().Get("query") if query == "" { @@ -203,6 +211,8 @@ func (s *Server) collections(w http.ResponseWriter, r *http.Request) { return } + //TODO + limit, offset := pagination(r) recent, err := getCollections(s.Db, query, limit, offset) @@ -214,18 +224,18 @@ func (s *Server) collections(w http.ResponseWriter, r *http.Request) { writeJSON(w, recent, http.StatusOK) } -// @Summary Searches collections based on a query -// @Description Searches collections in the database based on the query parameter -// @Tags search -// @Accept json -// @Produce json -// @Param query query string true "Search query" -// @Param limit query int false "Limit the number of results" default(10) -// @Param offset query int false "Offset for pagination" default(0) -// @Success 200 {array} Collection "List of collections" -// @Failure 400 {object} string "Bad Request" -// @Failure 500 {object} string "Internal Server Error" -// @Router /search/collections [get] +// @Summary Searches collections based on a query +// @Description Searches collections in the database based on the query parameter +// @Tags search +// @Accept json +// @Produce json +// @Param query query string true "Search query" +// @Param limit query int false "Limit the number of results" default(10) +// @Param offset query int false "Offset for pagination" default(0) +// @Success 200 {array} Collection "List of collections" +// @Failure 400 {object} string "Bad Request" +// @Failure 500 {object} string "Internal Server Error" +// @Router /search/collections [get] func (s *Server) collectionSearch(w http.ResponseWriter, r *http.Request) { q := r.URL.Query().Get("query") if q == "" { @@ -233,6 +243,8 @@ func (s *Server) collectionSearch(w http.ResponseWriter, r *http.Request) { return } + //TODO + limit, offset := pagination(r) recent, err := getCollections(s.Db, q, limit, offset) @@ -244,18 +256,18 @@ func (s *Server) collectionSearch(w http.ResponseWriter, r *http.Request) { writeJSON(w, recent, http.StatusOK) } -// @Summary Searches active records based on a query -// @Description Searches active records in the database based on the query parameter -// @Tags search -// @Accept json -// @Produce json -// @Param query query string true "Search query" -// @Param limit query int false "Limit the number of results" default(10) -// @Param offset query int false "Offset for pagination" default(0) -// @Success 200 {object} ActiveSearch "Active search result" -// @Failure 400 {object} string "Bad Request" -// @Failure 500 {object} string "Internal Server Error" -// @Router /search/active [get] +// @Summary Searches active records based on a query +// @Description Searches active records in the database based on the query parameter +// @Tags search +// @Accept json +// @Produce json +// @Param query query string true "Search query" +// @Param limit query int false "Limit the number of results" default(10) +// @Param offset query int false "Offset for pagination" default(0) +// @Success 200 {object} ActiveSearch "Active search result" +// @Failure 400 {object} string "Bad Request" +// @Failure 500 {object} string "Internal Server Error" +// @Router /search/active [get] func (s *Server) activeSearch(w http.ResponseWriter, r *http.Request) { q := r.URL.Query().Get("query") if q == "" { @@ -263,6 +275,7 @@ func (s *Server) activeSearch(w http.ResponseWriter, r *http.Request) { return } + //TODO limit, offset := pagination(r) recent, err := getSearch(s.Db, q, limit, offset) @@ -274,18 +287,18 @@ func (s *Server) activeSearch(w http.ResponseWriter, r *http.Request) { writeJSON(w, recent, http.StatusOK) } -// @Summary Searches for artists based on a query -// @Description Searches for artists in the database based on the query parameter -// @Tags search -// @Accept json -// @Produce json -// @Param query query string true "Search query" -// @Param limit query int false "Limit the number of results" default(10) -// @Param offset query int false "Offset for pagination" default(0) -// @Success 200 {array} string "List of artists" -// @Failure 400 {object} string "Bad Request" -// @Failure 500 {object} string "Internal Server Error" -// @Router /search/artist [get] +// @Summary Searches for artists based on a query +// @Description Searches for artists in the database based on the query parameter +// @Tags search +// @Accept json +// @Produce json +// @Param query query string true "Search query" +// @Param limit query int false "Limit the number of results" default(10) +// @Param offset query int false "Offset for pagination" default(0) +// @Success 200 {array} string "List of artists" +// @Failure 400 {object} string "Bad Request" +// @Failure 500 {object} string "Internal Server Error" +// @Router /search/artist [get] func (s *Server) artistSearch(w http.ResponseWriter, r *http.Request) { q := r.URL.Query().Get("query") if q == "" { @@ -293,6 +306,7 @@ func (s *Server) artistSearch(w http.ResponseWriter, r *http.Request) { return } + //TODO limit, offset := pagination(r) recent, err := getArtists(s.Db, q, limit, offset) @@ -304,16 +318,16 @@ func (s *Server) artistSearch(w http.ResponseWriter, r *http.Request) { writeJSON(w, recent, http.StatusOK) } -// @Summary Retrieves a song file by its encoded path -// @Description Retrieves a song file from the server based on the provided encoded filepath -// @Tags files -// @Accept json -// @Produce json -// @Param filepath path string true "Base64 encoded file path" -// @Success 200 {file} File "The requested song file" -// @Failure 400 {object} string "Bad Request" -// @Failure 404 {object} string "File Not Found" -// @Router /audio/{filepath} [get] +// @Summary Retrieves a song file by its encoded path +// @Description Retrieves a song file from the server based on the provided encoded filepath +// @Tags files +// @Accept json +// @Produce json +// @Param filepath path string true "Base64 encoded file path" +// @Success 200 {file} File "The requested song file" +// @Failure 400 {object} string "Bad Request" +// @Failure 404 {object} string "File Not Found" +// @Router /audio/{filepath} [get] func (s *Server) songFile(w http.ResponseWriter, r *http.Request) { f := r.PathValue("filepath") if f == "" { @@ -346,16 +360,16 @@ func (s *Server) songFile(w http.ResponseWriter, r *http.Request) { http.ServeContent(w, r, stat.Name(), stat.ModTime(), file) } -// @Summary Retrieves an image file by its encoded path -// @Description Retrieves an image file from the server based on the provided encoded filepath -// @Tags files -// @Accept json -// @Produce json -// @Param filepath path string true "Base64 encoded file path" -// @Success 200 {file} File "The requested image file" -// @Failure 400 {object} string "Bad Request" -// @Failure 404 {object} string "File Not Found" -// @Router /image/{filepath} [get] +// @Summary Retrieves an image file by its encoded path +// @Description Retrieves an image file from the server based on the provided encoded filepath +// @Tags files +// @Accept json +// @Produce json +// @Param filepath path string true "Base64 encoded file path" +// @Success 200 {file} File "The requested image file" +// @Failure 400 {object} string "Bad Request" +// @Failure 404 {object} string "File Not Found" +// @Router /image/{filepath} [get] func (s *Server) imageFile(w http.ResponseWriter, r *http.Request) { f := r.PathValue("filepath") if f == "" {