diff --git a/get_ping.md b/get_ping.md new file mode 100644 index 0000000..0a9550e --- /dev/null +++ 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" +``` \ No newline at end of file