API请求参数样例如何写

API请求参数的样例可以通过以下方式进行编写：

1. 使用表格：创建一个表格，包含参数名称、类型、是否必需、默认值和说明等列。在示例行中填写具体的参数值。例如：

| 参数名称 | 类型 | 是否必需 | 默认值 | 说明 |
|-----------|--------|----------|--------|----------------------|
| username | string | required | | 用户名 |
| password | string | required | | 密码 |
| page | int | optional | 1 | 页码，用于分页请求 |
| limit | int | optional | 10 | 每页结果数量限制 |
| sort | string | optional | | 排序方式 |

2. 使用示例代码注释：在API文档中，可以使用示例代码的注释部分来展示请求参数的样例。例如：

# 请求示例
"""
GET /api/users?username=john.doe&sort=asc
"""

# 请求参数说明
"""
- username: john.doe (string, required) - 用户名
- sort: asc (string, optional) - 排序方式
"""

3. 使用具体的请求URL：在文档中直接展示具体的请求URL，包含参数和值。例如：

GET /api/users?username=john.doe&sort=asc

以上是几种常见的编写API请求参数样例的方式。无论采用哪种方式，都需要确保参数名称、类型、是否必需以及默认值等信息清晰明了，并提供足够的示例和说明，以帮助用户正确构造API请求。