Skip to main content

User Management API

Version 1.0.0

API for managing users in an application.

Path Table​

MethodPathDescription
GET/usersList users
POST/usersCreate a user
GET/users/{id}Get a user by ID
PUT/users/{id}Update a user
DELETE/users/{id}Delete a user

Reference Table​

NamePathDescription
User#/components/schemas/User
UserCreate#/components/schemas/UserCreate
UserUpdate#/components/schemas/UserUpdate

Path Details​

GET /users​

  • Summary
    List users

Responses​

  • 200 A list of users

POST /users​

  • Summary
    Create a user

RequestBody​

  • application/json
{
  name: string
  email: string
}

Responses​

  • 201 User created

application/json

{
  id?: string
  name?: string
  email?: string
}

GET /users/{id}​

  • Summary
    Get a user by ID

Responses​

  • 200 User found

application/json

{
  id?: string
  name?: string
  email?: string
}
  • 404 User not found

PUT /users/{id}​

  • Summary
    Update a user

RequestBody​

  • application/json
{
  name?: string
  email?: string
}

Responses​

  • 200 User updated

application/json

{
  id?: string
  name?: string
  email?: string
}
  • 404 User not found

DELETE /users/{id}​

  • Summary
    Delete a user

Responses​

  • 204 User deleted

  • 404 User not found

References​

#/components/schemas/User​

{
  id?: string
  name?: string
  email?: string
}

#/components/schemas/UserCreate​

{
  name: string
  email: string
}

#/components/schemas/UserUpdate​

{
  name?: string
  email?: string
}