98 lines
2.8 KiB
YAML
98 lines
2.8 KiB
YAML
Lista todos os usuários
|
|
---
|
|
tags:
|
|
- Users
|
|
summary: Lista todos os usuários com paginação
|
|
security:
|
|
- bearerAuth: []
|
|
parameters:
|
|
- in: query
|
|
name: page
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
default: 1
|
|
description: Número da página a ser retornada
|
|
- in: query
|
|
name: per_page
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
default: 10
|
|
description: Número de usuários por página
|
|
responses:
|
|
200:
|
|
description: Lista de usuários com informações de paginação
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
description: Número total de usuários
|
|
pages:
|
|
type: integer
|
|
description: Número total de páginas
|
|
current_page:
|
|
type: integer
|
|
description: Página atual
|
|
per_page:
|
|
type: integer
|
|
description: Número de itens por página
|
|
users:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: ID do usuário
|
|
username:
|
|
type: string
|
|
description: Nome de usuário
|
|
email:
|
|
type: string
|
|
description: Email do usuário
|
|
phone:
|
|
type: string
|
|
description: Telefone do usuário
|
|
profile_image:
|
|
type: string
|
|
description: URL da imagem de perfil do usuário
|
|
birth_date:
|
|
type: string
|
|
format: date
|
|
description: Data de nascimento do usuário
|
|
examples:
|
|
application/json:
|
|
total: 2
|
|
pages: 1
|
|
current_page: 1
|
|
per_page: 10
|
|
users:
|
|
- id: 1
|
|
username: "usuario1"
|
|
email: "usuario1@example.com"
|
|
phone: "1234567890"
|
|
profile_image: "http://example.com/images/usuario1.jpg"
|
|
birth_date: "1990-01-01"
|
|
- id: 2
|
|
username: "usuario2"
|
|
email: "usuario2@example.com"
|
|
phone: "0987654321"
|
|
profile_image: "http://example.com/images/usuario2.jpg"
|
|
birth_date: "1985-05-10"
|
|
401:
|
|
description: Token inválido ou ausente
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
error:
|
|
type: string
|
|
examples:
|
|
application/json:
|
|
error: "Token inválido ou ausente"
|