/atividade_flask_swagger

Repositório referente a atividade de criar uma API usando Flask e Swagger

Primary LanguagePython

API - Sistema de Agenda

Fazer login

POST /users/login

HTTP Request Body

{
  "name": "string",
  "password": "string"
}

HTTP Response

Status 204 No Content

Fazer logout

GET /users/:id/logout

HTTP Params

Parâmetro Tipo Descrição Obrigatório ✅/ Opcional ❌
id (Path Variable) string ID de identificação do usuário ✅

HTTP Response

Status 204 No Content

Fazer cadastro de usuário

POST /users

HTTP Request Body

{
  "name": "string",
  "email": "string",
  "password": "string"
}

HTTP Response

Status 200 OK

{
  "id": "string",
  "name": "string",
  "email": "string",
  "password": "string",
  "status": "number"
}

Deletar conta de usuário

DELETE /users/:id

HTTP Params

Parâmetro Tipo Descrição Obrigatório ✅/ Opcional ❌
id (Path Variable) string ID de identificação do usuário ✅

HTTP Response

Status 200 OK

Atualizar conta de usuário

PATCH /users/:id

Parâmetro Tipo Descrição Obrigatório ✅/ Opcional ❌
id (Path Variable) string ID de identificação do usuário ✅

HTTP Request Body

{
  "name": "string",
  "email": "string",
  "password": "string"
}

HTTP Response

Status 200 OK

{
  "id": "string",
  "name": "string",
  "email": "string",
  "password": "string",
  "status": "number"
}

Buscar por id a conta de usuário

GET /users/:id

Parâmetro Tipo Descrição Obrigatório ✅/ Opcional ❌
id (Path Variable) string ID de identificação do usuário ✅

HTTP Response

Status 200 OK

{
  "id": "string",
  "name": "string",
  "email": "string",
  "password": "string",
  "status": "number"
}

Cadastrar evento

POST /users/:id/events

Parâmetro Tipo Descrição Obrigatório ✅/ Opcional ❌
id (Path Variable) string ID de identificação do usuário ✅

HTTP Request Body

{
  "title": "string",
  "datetime": "datetime",
  "description": "string"
}

HTTP Response

Status 200 OK

{
  "id": "string",
  "title": "string",
  "datetime": "datetime",
  "description": "string",
  "status": "number"
}

Deletar evento

DELETE /users/:id/events/:eventid

Parâmetro Tipo Descrição Obrigatório ✅/ Opcional ❌
id (Path Variable) string ID de identificação do usuário ✅
eventId (Path Variable) string ID de identificação do evento ✅

HTTP Response

Status 200 OK

Atualizar evento

PATCH /users/:id/events/:eventid

Parâmetro Tipo Descrição Obrigatório ✅/ Opcional ❌
id (Path Variable) string ID de identificação do usuário ✅
eventId (Path Variable) string ID de identificação do evento ✅

HTTP Request Body

{
  "title": "string",
  "datetime": "datetime",
  "description": "string"
}

HTTP Response

Status 200 OK

{
  "id": "string",
  "title": "string",
  "datetime": "datetime",
  "description": "string",
  "status": "number"
}

Visualizar eventos por dia

GET /users/:id/events?day=[date]

Parâmetro Tipo Descrição Obrigatório ✅/ Opcional ❌
id (Path Variable) string ID de identificação do usuário ✅
day date Data do dia desejado no formato dd-mm-yyyy ✅

HTTP Response

Status 200 OK

[
  {
    "id": "string",
    "title": "string",
    "datetime": "datetime",
    "description": "string",
    "status": "number"
  }
  ...
]

Visualizar eventos por mês e semana

GET /users/:id/events?startDate=[date]&endDate=[date]

Parâmetro Tipo Descrição Obrigatório ✅/ Opcional ❌
id (Path Variable) string ID de identificação do usuário ✅
startDate date Data do dia inicial de datas desejadas no formato dd-mm-yyyy ✅
endDate date Data do dia final de datas desejadas no formato dd-mm-yyyy ✅

HTTP Response

Status 200 OK

[
  {
    "id": "string",
    "title": "string",
    "datetime": "datetime",
    "description": "string",
    "status": "number"
  }
  ...
]