Mẫu Tài liệu API Markdown

Mẫu tài liệu API Markdown

2023-11-25

Tài liệu API Sử dụng Markdown

Markdown cung cấp một cách đơn giản để tài liệu hóa API của bạn, làm cho nó dễ đọc trên web và trong các trình soạn thảo văn bản. Dưới đây là một mẫu cơ bản:

# Tên API

## Điểm cuối: `/example-endpoint`

- **Phương thức:** `GET`
- **Mô tả:** Lấy dữ liệu ví dụ.

### Tham số yêu cầu

- `param1` (bắt buộc): Mô tả của param1.
- `param2` (tùy chọn): Mô tả của param2.

### Phản hồi

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


Hãy nhớ bao gồm thông tin cần thiết như phương thức xác thực, giới hạn tốc độ và mã phản hồi để làm cho tài liệu của bạn toàn diện.