แบบฟอร์มเอกสาร API ของ Markdown

เอกสารอ้างอิง API Markdown

2023-11-25

เอกสาร API โดยใช้ Markdown

Markdown มีวิธีที่ง่ายในการจัดทำเอกสาร API ของคุณ ทำให้สามารถอ่านได้ทั้งบนเว็บและในตัวแก้ไขข้อความ นี่คือตัวอย่างเทมเพลตพื้นฐาน:

# ชื่อ API

## จุดสิ้นสุด: `/example-endpoint`

- **วิธีการ:** `GET`
- **คำอธิบาย:** ดึงข้อมูลตัวอย่าง

### พารามิเตอร์คำขอ

- `param1` (จำเป็น): คำอธิบายของ param1.
- `param2` (ไม่จำเป็น): คำอธิบายของ param2.

### การตอบกลับ

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


โปรดจำไว้ว่าต้องรวมข้อมูลที่สำคัญเช่น วิธีการตรวจสอบสิทธิ์ ขีดจำกัดอัตรา และรหัสการตอบกลับ เพื่อทำให้เอกสารของคุณครอบคลุม