Bem-vindo à documentação da API Campus Connect Server. Abaixo estão detalhes sobre as rotas disponíveis, os métodos HTTP permitidos e uma breve descrição do que cada rota realiza.
- Descrição: Rota para autenticar um usuário.
- Método HTTP: POST
- Body:
academicRegistration
(string): Matrícula acadêmica do usuário.password
(string): Senha do usuário.
- Descrição: Obter informações do usuário autenticado.
- Método HTTP: GET
- Autenticação: Token JWT necessário.
- Descrição: Obter informações de um usuário específico.
- Método HTTP: GET
- Autenticação: Token JWT necessário.
- Parâmetros URL:
id
(string): ID do usuário.
- Descrição: Atualizar informações do usuário autenticado.
- Método HTTP: PATCH
- Autenticação: Token JWT necessário.
- Body: Campos a serem atualizados.
- Descrição: Excluir a conta do usuário autenticado.
- Método HTTP: DELETE
- Autenticação: Token JWT necessário.
- Descrição: Buscar usuários por nome, username, academicSchedule, entryYear e entryPeriod.
- Método HTTP: GET
- Autenticação: Token JWT necessário.
- Parâmetros URL:
query
(string): Termo de busca.
- Descrição: Seguir um usuário.
- Método HTTP: PATCH
- Autenticação: Token JWT necessário.
- Parâmetros URL:
id
(string): ID do usuário a ser seguido.
- Descrição: Deixar de seguir um usuário.
- Método HTTP: PATCH
- Autenticação: Token JWT necessário.
- Parâmetros URL:
id
(string): ID do usuário a ser deixado de seguir.
- Descrição: Fazer upload de arquivos.
- Método HTTP: POST
- Autenticação: Token JWT necessário.
- Requisição: Multipart/form-data com o arquivo.
- Descrição: Baixar um arquivo por ID.
- Método HTTP: GET
- Autenticação: Token JWT necessário.
- Parâmetros URL:
id
(string): ID do arquivo.
- Descrição: Excluir um arquivo por ID.
- Método HTTP: DELETE
- Autenticação: Token JWT necessário.
- Parâmetros URL:
id
(string): ID do arquivo.
- Descrição: Criar um novo post.
- Método HTTP: POST
- Autenticação: Token JWT necessário.
- Body: Campos do post.
- Descrição: Obter todos os posts.
- Método HTTP: GET
- Autenticação: Token JWT necessário.
- Descrição: Obter os posts de um usuário específico.
- Método HTTP: GET
- Autenticação: Token JWT necessário.
- Parâmetros URL:
userId
(string): ID do usuário.
- Descrição: Curtir um post.
- Método HTTP: PATCH
- Autenticação: Token JWT necessário.
- Parâmetros URL:
postId
(string): ID do post.
- Descrição: Não curtir um post.
- Método HTTP: PATCH
- Autenticação: Token JWT necessário.
- Parâmetros URL:
postId
(string): ID do post.
- Descrição: Excluir um post.
- Método HTTP: DELETE
- Autenticação: Token JWT necessário.
- Parâmetros URL:
postId
(string): ID do post.
- Descrição: Comentar em um post.
- Método HTTP: PATCH
- Autenticação: Token JWT necessário.
- Parâmetros URL:
postId
(string): ID do post. - Body: Conteúdo do comentário.