commit 1d8b43767595ed57b6d69094036bb71af62a0a96 Author: david Date: Sat May 20 17:59:24 2023 +0200 SearchAPI ins Wiki hinzugefügt. diff --git a/SearchAPI.md b/SearchAPI.md new file mode 100644 index 0000000..39a6161 --- /dev/null +++ b/SearchAPI.md @@ -0,0 +1,26 @@ +Willkommen im Wiki. + +# SearchAPI + +## Search +`GET /api/search/?param=value` + +### Parameters +| Param | Value | +|-|-| +| `q` | The search query string. | +| `limit` | A limit on the number of objects to be returned. Default is 6. | + +### Response +``` +[ + { + "id": 1, + "name": "Video 1" + }, + {...} +] +``` + +### Examples +> `GET /api/search/?q=foo&limit=3` will return the first 3 videos with "foo" in their name. \ No newline at end of file