Add get_ping
parent
af7bc39612
commit
94a4878e78
21
get_ping.md
Normal file
21
get_ping.md
Normal file
@ -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"
|
||||||
|
```
|
Loading…
Reference in New Issue
Block a user