Skip to content

API: Recurso Usuários

Lucas Souza edited this page Jul 6, 2019 · 9 revisions

Listar usuários

Método: GET

URL: /api/users

Implementa

Retorno

Status: 200

Corpo: Array de User

Filtrar usuários

Método: GET

URL: /api/users?username=name&paginate=false

Implementa

Query string

Nome Tipo Descrição Exemplo
useranme String Busca por nome '%meio%','inicio%','fim%'
paginate Booleano Ignora paginação 'false'

Retorno

Status: 200

Corpo: Array de User

Ver usuário

Método: GET

URL: /api/users/:id

Implementa

Parâmetros do URL

id: Chave primária do usuário.

Retorno

Status: 200

Corpo: User

Cria usuário

Método: POST

URL: /api/users

Implementa

Corpo

username: Nome de usuário.

password: Senha.

email: E-mail do usuário.

role: Papel do usuário 'admin'|'teacher'.

Retorno

Status: 201

Corpo: User

Atualiza usuário

Método: PUT

URL: /api/users/:id

Implementa

Corpo

password: Senha.

Retorno

Status: 200

Corpo: User

Exceções

Código Descrição
FORBIDDEN Pode ocorrer se um professor tentar atualizar uma senha que não seja a sua