Markdown Toolbox Logo Markdown Toolbox
Rumah
Blog

Kami memiliki halaman lain dalam bahasa Inggris. Apakah Anda ingin mengganti bahasa?

We have another page in English. Would you like to change languages?

Ya / Yes Tidak / No

Dokumentasi API Markdown Template

2023-11-25

Dokumentasi API Menggunakan Markdown

Markdown menyediakan cara sederhana untuk mendokumentasikan API Anda, membuatnya dapat dibaca baik di web maupun di editor teks. Berikut adalah template dasar:

# Nama API

## Endpoint: `/example-endpoint`

- **Metode:** `GET`
- **Deskripsi:** Mengambil data contoh.

### Parameter Permintaan

- `param1` (wajib): Deskripsi dari param1.
- `param2` (opsional): Deskripsi dari param2.

### Respons

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

Ingatlah untuk menyertakan informasi penting seperti metode autentikasi, batasan laju, dan kode respons untuk membuat dokumentasi Anda komprehensif.