Files
api/documentation/topics/API-Overview.topic
T

33 lines
1.1 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic
SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="API Overview" id="API-Overview">
<p>This section provides a high-level overview of how to interact with the API.</p>
<chapter title="Base URL" id="base-url">
<code-block lang="text">
https://api.truckwash.dk/api/v1
</code-block>
</chapter>
<chapter title="Common Headers" id="common-headers">
<table>
<tr>
<td>Header</td>
<td>Description</td>
</tr>
<tr>
<td>Content-Type</td>
<td>Should be application/json for all POST/PUT requests.</td>
</tr>
<tr>
<td>Accept</td>
<td>application/json is recommended.</td>
</tr>
</table>
</chapter>
</topic>