Add get_ping

2024-03-25 10:21:00 +00:00 · 2024-03-25 10:21:00 +00:00 · 94a4878e78
commit 94a4878e78
parent af7bc39612
1 changed files with 21 additions and 0 deletions
--- a/get_ping.md
+++ b/get_ping.md
@ -0,0 +1,21 @@
+# Ping API Endpoint
+
+## GET `/api/ping`
+
+Shows whether the api is up and running. Accessible from http://url/api/ping
+
+## Responses
+
+- `200 OK`: The api is up and running
+
+## Example Request
+
+```bash
+curl -X GET "https://url/api/ping
+```
+
+## Example Response
+
+```
+"Hello World! I'm A rocket Webserver"
+```