From 2cde1dc8eadd652c8151682a4a33d710b238a913 Mon Sep 17 00:00:00 2001 From: LamGC Date: Thu, 22 Jun 2023 12:50:37 +0800 Subject: [PATCH] Docs: Supplement the document for the cache parameter at the "/backgroundImage" endpoint. P.S. If I were to speak, it would probably be a lengthy discussion, so I tried to briefly explain its usage. --- docs/docs/development/SC/api.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/docs/development/SC/api.md b/docs/docs/development/SC/api.md index 6c14e3fd..e1bd078d 100644 --- a/docs/docs/development/SC/api.md +++ b/docs/docs/development/SC/api.md @@ -50,6 +50,12 @@ Current map background image * Base url with no parameters returns map image file as-is without any processing. * setting `width` or `height` query parameters ensures that at least one of these will be matched while preserving original image aspect ratio. [check it out](http://localhost:20727/backgroundImage?width=500&height=500) * in addition, setting `crop=1` disregards image aspect ratio and returns cropped image with specified dimensions, resizing it beforehand if necessary. [check it out](http://localhost:20727/backgroundImage?width=500&height=500&crop=1) +* Add `cache=true` to query parameters, and SC will set the [**Cache-Control**](https://developer.mozilla.org/docs/Web/HTTP/Headers/Cache-Control) response header to instruct the browser to cache background images. When images are repeatedly loaded, it will save a lot of loading time. + * When using caching, it is necessary to add some query parameters to distinguish requests. If no other parameters are added, it will cause the browser to always use the background image of the first beatmap instead of refreshing it to the background image of other beatmap. For example, you can set the Id of the current Beatmap to the query parameters: + + ``` + /backgroundImage?cache=true&mapId=123456 + ``` ### [`Songs`](http://localhost:20727/Songs)