Markdown Toolbox Logo Markdown Toolbox
Home
Blog

Markdown API Documentation Template

Saturday, November 25, 2023

API Documentation Using Markdown

Markdown provides a simple way to document your API, making it readable both on the web and in text editors. Here's a basic template:

# API Name

## Endpoint: `/example-endpoint`

- **Method:** `GET`
- **Description:** Retrieves example data.

### Request Parameters

- `param1` (required): Description of param1.
- `param2` (optional): Description of param2.

### Response

```json
{
  "data": "Sample data"
}

Remember to include essential information like authentication methods, rate limits, and response codes to make your documentation comprehensive.