Commit bb81b7d8 authored by Themis Zamani's avatar Themis Zamani

An api documentation page template

parent fc0911d6
---
title: API | [API CALL NAME]
description: [One line description]
---
# API - [API CALL NAME] - Description
[A descriptive paragraph about the call]
## Basic Parameters
| **Description** | [API CALL DESCRIPTION] |
| **URL** | [The API Service URL] |
| **HTTP Method** | [METHOD TYPE GET /POST ....] |
| **Security** | Basic Authentication |
### Headers
Type | Description | Required | Default value | Example value |
------|-------------|----------|---------------|---------------|
token | ....... | `Yes` |None| |
### Parameters
Name | Description | Required | Default value | Example value |
------|-------------|----------|---------------|---------------|
..... | ....... |`Yes` |None| |
## Example
In this example we are going to ....
The request in curl
<pre><code>
curl .....
</code></pre>
### Response body
<pre><code>
</code></pre>
### Response messages
The main response messages are:
- HTTP/1.1 201 OK : (Success) ..
- ...
- ...
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment