40 lines
2.3 KiB
HTML
40 lines
2.3 KiB
HTML
|
|
||
|
|
<html>
|
||
|
|
<head>
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
|
|
<link rel="stylesheet" href="github-markdown.css">
|
||
|
|
</head>
|
||
|
|
<body class="markdown-body">
|
||
|
|
<style>
|
||
|
|
.markdown-body {
|
||
|
|
box-sizing: border-box;
|
||
|
|
min-width: 200px;
|
||
|
|
max-width: 980px;
|
||
|
|
margin: 0 auto;
|
||
|
|
padding: 45px;
|
||
|
|
}
|
||
|
|
|
||
|
|
@media (max-width: 767px) {
|
||
|
|
.markdown-body {
|
||
|
|
padding: 15px;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
</style>
|
||
|
|
<div class="markdown-heading"><h1 class="heading-element">Ping API Endpoint</h1><a id="user-content-ping-api-endpoint" class="anchor" aria-label="Permalink: Ping API Endpoint" href="#ping-api-endpoint"><span aria-hidden="true" class="octicon octicon-link"></span></a></div>
|
||
|
|
<div class="markdown-heading"><h2 class="heading-element">GET <code>/api/ping</code>
|
||
|
|
</h2><a id="user-content-get-apiping" class="anchor" aria-label="Permalink: GET /api/ping" href="#get-apiping"><span aria-hidden="true" class="octicon octicon-link"></span></a></div>
|
||
|
|
<p>Shows whether the api is up and running. Accessible from <a href="http://url/api/ping" rel="nofollow">http://url/api/ping</a></p>
|
||
|
|
<div class="markdown-heading"><h2 class="heading-element">Responses</h2><a id="user-content-responses" class="anchor" aria-label="Permalink: Responses" href="#responses"><span aria-hidden="true" class="octicon octicon-link"></span></a></div>
|
||
|
|
<ul>
|
||
|
|
<li>
|
||
|
|
<code>200 OK</code>: The api is up and running</li>
|
||
|
|
</ul>
|
||
|
|
<div class="markdown-heading"><h2 class="heading-element">Example Request</h2><a id="user-content-example-request" class="anchor" aria-label="Permalink: Example Request" href="#example-request"><span aria-hidden="true" class="octicon octicon-link"></span></a></div>
|
||
|
|
<div class="highlight highlight-source-shell"><pre>curl -X GET <span class="pl-s"><span class="pl-pds">"</span>https://url/api/ping</span></pre></div>
|
||
|
|
<div class="markdown-heading"><h2 class="heading-element">Example Response</h2><a id="user-content-example-response" class="anchor" aria-label="Permalink: Example Response" href="#example-response"><span aria-hidden="true" class="octicon octicon-link"></span></a></div>
|
||
|
|
<pre><code>"Hello World! I'm A rocket Webserver"
|
||
|
|
</code></pre>
|
||
|
|
</body>
|
||
|
|
</html>
|
||
|
|
|