欢迎访问宙启技术站
智能推送

用户视图集API:获取所有用户列表

发布时间:2024-01-01 04:31:09

API名称:用户视图集API(UserViewSet API)

API描述:

用户视图集API是一个用于获取所有用户列表的API接口。它提供了查询和获取用户信息的功能,以及对用户列表进行增加、编辑和删除。

使用例子:

1. 获取所有用户列表:

请求URL:/api/users/

请求方法:GET

请求参数:无

响应示例:

[
    {
        "id": 1,
        "username": "user1",
        "email": "user1@example.com",
        "first_name": "John",
        "last_name": "Doe"
    },
    {
        "id": 2,
        "username": "user2",
        "email": "user2@example.com",
        "first_name": "Jane",
        "last_name": "Smith"
    },
    ...
]

2. 获取指定用户的信息:

请求URL:/api/users/{id}/

请求方法:GET

请求参数:{id} - 用户的ID

响应示例:

{
    "id": 1,
    "username": "user1",
    "email": "user1@example.com",
    "first_name": "John",
    "last_name": "Doe"
}

3. 增加用户:

请求URL:/api/users/

请求方法:POST

请求参数:

{
    "username": "newuser",
    "email": "newuser@example.com",
    "first_name": "New",
    "last_name": "User"
}

响应示例:

{
    "id": 1001,
    "username": "newuser",
    "email": "newuser@example.com",
    "first_name": "New",
    "last_name": "User"
}

4. 编辑用户信息:

请求URL:/api/users/{id}/

请求方法:PUT

请求参数:

{
    "username": "updateduser",
    "email": "updateduser@example.com",
    "first_name": "Updated",
    "last_name": "User"
}

响应示例:

{
    "id": 1001,
    "username": "updateduser",
    "email": "updateduser@example.com",
    "first_name": "Updated",
    "last_name": "User"
}

5. 删除用户:

请求URL:/api/users/{id}/

请求方法:DELETE

请求参数:{id} - 需要删除的用户ID

响应示例:无

总结:

以上是用户视图集API的使用例子,通过该API可以方便地查询、获取、增加、编辑和删除用户列表。用户视图集API提供了对用户的基本操作,可用于开发用户管理系统或其他需要进行用户管理的应用。