Markdown Toolbox Logo Markdown Toolbox
Ev
Blog

Markdown API Dokümantasyon Şablonu

2023-11-25

API Dokümantasyonu Markdown Kullanarak

Markdown, API’nizi belgelemenin basit bir yolunu sunar ve onu hem web’de hem de metin editörlerinde okunabilir hale getirir. İşte temel bir şablon:

# API Adı

## Uç Nokta: `/example-endpoint`

- **Yöntem:** `GET`
- **Açıklama:** Örnek verileri alır.

### İstek Parametreleri

- `param1` (gerekli): param1 açıklaması.
- `param2` (isteğe bağlı): param2 açıklaması.

### Yanıt

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

Belgelerinizi kapsamlı hale getirmek için kimlik doğrulama yöntemleri, hız limitleri ve yanıt kodları gibi temel bilgileri eklemeyi unutmayın.