API Restful para monitoramento de estudo e criação de tarefas. Nela você pode inserir provas que você irá fazer e as respectivas matérias. Além disso, ainda pode inserir a quantidade de questões que fez/acertou em determinado dia para que possa acompanhar seu desempenho no decorrer do tempo.
Contato: Dev Filipe
Email: [email protected]
Licença: Apache 2.0
Antes de tudo, faça o login, pegue o token JWT retornado e insira no cabeçalho das requisições com a chave "Authorization"!
Cria um novo usuário.
- Operation ID:
criarUsuario
- Corpo da requisição:
- Conteúdo:
{ "login":"[email protected]", "nome":"Fulano de Tal", "senha":"123456" }
- Conteúdo:
- Respostas:
200 OK
- Schema:
{ "id": 1, "login": "[email protected]", "nome": "Fulano de Tal" }
- Schema:
Realiza a autenticação do usuário.
- Operation ID:
efetuarLogin
- Corpo da requisição:
- Conteúdo:
{ "login":"[email protected]", "senha":"123456" }
- Conteúdo:
- Respostas:
200 OK
- Schema:
{ "tokenJWT": "token JWT" }
- Schema:
Retorna os dados de uma tarefa específica.
- Operation ID:
obterDadosTarefaEspecifica
- Parâmetros:
idTarefa
(path) - ID da tarefa a ser obtida (integer, int64)
- Respostas:
200 OK
- Schema:
{ "$ref": "#/components/schemas/DadosDetalhamentoTarefaDTO" }
- Schema:
- Segurança:
- Necessita token JWT (
bearer-key
).
- Necessita token JWT (
Altera os dados de uma tarefa específica.
- Operation ID:
alterarTarefa
- Parâmetros:
idTarefa
(path) - ID da tarefa a ser alterada (integer, int64)
- Corpo da requisição:
- Conteúdo:
{ "$ref": "#/components/schemas/DadosCriacaoTarefasDTO" }
- Conteúdo:
- Respostas:
200 OK
- Schema:
{ "$ref": "#/components/schemas/DadosDetalhamentoTarefaDTO" }
- Schema:
- Segurança:
- Necessita token JWT (
bearer-key
).
- Necessita token JWT (
Marca uma tarefa como concluída.
- Operation ID:
concluirTarefa
- Parâmetros:
idTarefa
(path) - ID da tarefa a ser concluída (integer, int64)
- Respostas:
200 OK
- Schema:
{ "$ref": "#/components/schemas/DadosDetalhamentoTarefaDTO" }
- Schema:
- Segurança:
- Necessita token JWT (
bearer-key
).
- Necessita token JWT (
Lista todas as tarefas paginadas.
- Operation ID:
listarTarefas
- Parâmetros:
pageable
(query) - Configuração de paginação
- Respostas:
200 OK
- Schema:
{ "$ref": "#/components/schemas/PageDadosListagemTarefaDTO" }
- Schema:
- Segurança:
- Necessita token JWT (
bearer-key
).
- Necessita token JWT (
Cria uma nova tarefa.
- Operation ID:
inserirTarefa
- Corpo da requisição:
- Conteúdo:
{ "$ref": "#/components/schemas/DadosCriacaoTarefasDTO" }
- Conteúdo:
- Respostas:
200 OK
- Schema:
{ "$ref": "#/components/schemas/DadosDetalhamentoTarefaDTO" }
- Schema:
- Segurança:
- Necessita token JWT (
bearer-key
).
- Necessita token JWT (
Lista todas as provas paginadas.
- Operation ID:
getProvas
- Parâmetros:
pageable
(query) - Configuração de paginação
- Respostas:
200 OK
- Schema:
{ "$ref": "#/components/schemas/PageDadosDetalhamentoProvaDTO" }
- Schema:
- Segurança:
- Necessita token JWT (
bearer-key
).
- Necessita token JWT (
Cria uma nova prova.
- Operation ID:
inserirProva
- Corpo da requisição:
- Conteúdo:
{ "$ref": "#/components/schemas/DadosCriacaoProvaDTO" }
- Conteúdo:
- Respostas:
200 OK
- Schema:
{ "$ref": "#/components/schemas/DadosListagemProvaDTO" }
- Schema:
- Segurança:
- Necessita token JWT (
bearer-key
).
- Necessita token JWT (
Lista todas as matérias de uma prova paginadas.
- Operation ID:
getMaterias
- Parâmetros:
pageable
(query) - Configuração de paginaçãoidProva
(path) - ID da prova (integer, int64)
- Respostas:
200 OK
- Schema:
{ "$ref": "#/components/schemas/PageDadosListagemMateriaDTO" }
- Schema:
- Segurança:
- Necessita token JWT (
bearer-key
).
- Necessita token JWT (
Adiciona uma nova matéria a uma prova.
- Operation ID:
inserirMaterias
- Parâmetros:
idProva
(path) - ID da prova (integer, int64)
- Corpo da requisição:
- Conteúdo:
{ "$ref": "#/components/schemas/DadosCriacaoMateriaDTO" }
- Conteúdo:
- Respostas:
200 OK
- Schema:
{ "$ref": "#/components/schemas/DadosListagemMateriaDTO" }
- Schema:
- Segurança:
- Necessita token JWT (
bearer-key
).
- Necessita token JWT (
Adiciona questões a uma matéria de uma prova.
- Operation ID:
adicionarQuestoes
- Parâmetros:
idProva
(path) - ID da prova (integer, int64)idMateria
(path) - ID da matéria (integer, int64)
- Corpo da requisição:
- Conteúdo:
{ "$ref": "#/components/schemas/DadosCriacaoQuestaoDTO" }
- Conteúdo:
- Respostas:
200 OK
- Schema:
{ "$ref": "#/components/schemas/DadosListagemQuestoesDTO" }
- Schema:
- Segurança:
- Necessita token JWT (
bearer-key
).
- Necessita token JWT (
Retorna os dados do usuário autenticado.
- Operation ID:
retornaDadosUsuario
- Respostas:
200 OK
- Schema:
{ "$ref": "#/components/schemas/DadosUsuarioDTO" }
- Schema:
- Segurança:
- Necessita token JWT (
bearer-key
).
- Necessita token JWT (
Retorna os detalhes de uma prova específica.
- Operation ID:
getProva
- Parâmetros:
idProva
(path) - ID da prova a ser obtida (integer, int64)
- Respostas:
200 OK
- Schema:
{ "$ref": "#/components/schemas/DadosListagemProvaDTO" }
- Schema:
- Segurança:
- Necessita token JWT (
bearer-key
).
- Necessita token JWT (
Deleta uma prova específica.
- Operation ID:
deletarProva
- Parâmetros:
idProva
(path) - ID da prova a ser deletada (integer, int64)
- Respostas:
200 OK
- Segurança:
- Necessita token JWT (
bearer-key
).
- Necessita token JWT (