mentoria-api-flask/app/docs/user_docs.py
2025-03-05 21:35:50 -04:00

117 lines
3.3 KiB
Python

user_get_doc = {
"tags": ["Users"],
"summary": "Lista todos os usuários",
"responses": {
"200": {
"description": "Lista de usuários",
"examples": {
"application/json": [
{"id": 1, "name": "João", "email": "joao@email.com"}
]
}
}
}
}
user_post_doc = {
"tags": ["Usuários"],
"description": "Cria um novo usuário no sistema com senha",
"parameters": [
{
"name": "user",
"in": "body",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Nome do usuário",
"example": "João Silva"
},
"email": {
"type": "string",
"description": "Email do usuário",
"example": "joao.silva@example.com"
},
"password": {
"type": "string",
"description": "Senha do usuário",
"example": "senha123"
}
},
"required": ["name", "email", "password"]
}
],
"responses": {
"201": {
"description": "Usuário criado com sucesso",
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "Usuário registrado com sucesso!"
}
}
}
},
"400": {
"description": "Erro na validação dos dados",
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "Usuário já existe!"
}
}
}
}
}
}
login_post_doc = {
"tags": ["Usuários"],
"description": "Rota para login de usuário. Retorna um token JWT.",
"parameters": [
{
"name": "user",
"in": "body",
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "Email do usuário",
"example": "usuario@example.com"
},
"password": {
"type": "string",
"description": "Senha do usuário",
"example": "senha123"
}
},
"required": ["email", "password"]
}
],
"responses": {
"200": {
"description": "Login bem-sucedido",
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "Login bem-sucedido"
},
"token": {
"type": "string",
"example": "seu_token_jwt_aqui"
}
}
}
},
"401": {
"description": "Credenciais inválidas"
}
}
}