From b4da90376d5a781ab2a1545a4d3bf7d44f16d01e Mon Sep 17 00:00:00 2001 From: Arlo Date: Mon, 25 Mar 2024 10:21:13 +0000 Subject: [PATCH] Add get_test --- get_test.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 get_test.md diff --git a/get_test.md b/get_test.md new file mode 100644 index 0000000..6853b29 --- /dev/null +++ b/get_test.md @@ -0,0 +1,39 @@ +# Test API Endpoint + +## GET `/api/test` + +Returns 100 random words to be used to give a typing test. Retrieved from `wordlist.txt` + +## Responses + +- `200 OK`: Successfully retrieves the 100 words. +- `404 Not Found`: Indicates that the wordlist was not found. + +## Example Request + +```bash +curl -X GET "https://url/api/test" +``` + +## Example Response + +```json +[ + "separate", + "stand", + "think", + "island", + "have", + "air", + "heard", + "notice", + "yellow", + "smell", + "heart", + "island", + "chief", + "view", + "top", + ... +] +```