实践案例 (Examples)

以下展示了常用的资源操作案例。

CRUD 示例 (用户管理)

1. 列表查询 (带有过滤和分页)

`GET /users?page=1&per_page=15&role=admin`

2. 创建用户

`POST /users` ```json { "username": "api_user", "email": "user@example.com" } ```

3. 获取详情

`GET /users/42`

4. 更新数据

`PATCH /users/42` ```json { "username": "new_name" } ```

5. 删除用户

`DELETE /users/42`

高级功能规范

分页 (Pagination)

使用 `page` 和 `per_page` 参数进行分页。 响应中应包含元数据： ```json { "data": [...], "meta": { "current_page": 1, "total": 100, "last_page": 7 } } ```

排序 (Sorting)

使用 `sort` 参数，前缀 `-` 表示降序。

• 升序: `?sort=created_at`
• 降序: `?sort=-created_at`

字段选择 (Field Selection)

使用 `fields` 参数仅返回指定字段。

• `?fields=id,name,email`