User Management API (1.0.0-dev.1)

Download OpenAPI specification:Download

A Simple API for creating, editing, and deleting users. The goal here is to offer minimal flexability that is sufficient for demonstrating a backend server or database integration.

Search

Browsing database of users

List of users

header Parameters
If-None-Match
any

Makes the request conditional. The server will send back the requested resource only if it does not have an ETag matching the given one. For non-safe methods, it will only upload the resource in this case.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Display individual user

path Parameters
id
required
integer
Example: 15

ID of the respective user to display

header Parameters
If-None-Match
any

Makes the request conditional. The server will send back the requested resource only if it does not have an ETag matching the given one. For non-safe methods, it will only upload the resource in this case.

Responses

Response samples

Content type
application/json
{
  • "id": 234,
  • "name": "John Doe",
  • "email": "john@example.com"
}

Edit

Edit user's entry in database

Create a new user

Request Body schema: application/json

add a new user with given information

name
required
string (The Name Schema)

The name given to a user.

email
required
string <email> (The Email Schema)

The means of contact for a given user.

Responses

Request samples

Content type
application/json
{
  • "name": "John Doe",
  • "email": "john@example.com"
}

Response samples

Content type
application/json
{
  • "id": 234,
  • "name": "John Doe",
  • "email": "john@example.com"
}

Edit an existing user

path Parameters
id
required
integer
Example: 15

ID of the respective user to display

header Parameters
If-Match
required
any

Makes the request conditional. The server will send back the requested resource only if it matches one of the listed ETags. For non-safe methods, it will only upload the resource in this case.

Request Body schema: application/json

edit any number of settings for a given user

name
string (The Name Schema)

The name given to a user.

email
string <email> (The Email Schema)

The means of contact for a given user.

Responses

Request samples

Content type
application/json
Example
{
  • "name": "Jane Marry Doe"
}

Response samples

Content type
application/json
{
  • "id": 234,
  • "name": "John Doe",
  • "email": "john@example.com"
}

Remove an existing user

path Parameters
id
required
integer
Example: 15

ID of the respective user to display

header Parameters
If-Match
required
any

Makes the request conditional. The server will send back the requested resource only if it matches one of the listed ETags. For non-safe methods, it will only upload the resource in this case.

Responses

Response samples

Content type
application/json
{
  • "error": "specified id does not exist"
}

CORS

Preflight requests to support Cross-origin resource sharing (CORS). Describes access to a selected resources from a different origin

List

List

Responses

User

User

path Parameters
id
required
integer
Example: 15

ID of the respective user to display

Responses