21 lines
305 B
Markdown
21 lines
305 B
Markdown
|
# 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"
|
||
|
|
```
|