Markdown API 文档模板

2023-11-25

使用Markdown的API文档

Markdown提供了一种简单的方法来记录您的API，使其在网页和文本编辑器中都易于阅读。这里是一个基本模板：

# API名称

## 端点：`/example-endpoint`

- **方法：** `GET`
- **描述：** 检索示例数据。

### 请求参数

- `param1`（必需）：param1的描述。
- `param2`（可选）：param2的描述。

### 响应

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


请记得包括基础信息，如身份验证方法、速率限制和响应代码，以使您的文档全面。