Giter VIP home page Giter VIP logo

bruno-brandao-silva / campus-connect-server Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 124 KB

Campus Connect Server é o backend da aplicação Campus Connect, proporcionando autenticação segura, gerenciamento de arquivos e recursos sociais para facilitar a interação entre estudantes universitários. Desenvolvido em Node.js, Express e MongoDB. ~Desenvolvimento para Dispositivos Móveis.

TypeScript 98.81% Dockerfile 1.19%
api expressjs social-media

campus-connect-server's Introduction

Campus Connect Server

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.

Autenticação

POST /auth/login

  • 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.

Usuários

GET /users

  • Descrição: Obter informações do usuário autenticado.
  • Método HTTP: GET
  • Autenticação: Token JWT necessário.

GET /users/:id

  • 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.

PATCH /users

  • Descrição: Atualizar informações do usuário autenticado.
  • Método HTTP: PATCH
  • Autenticação: Token JWT necessário.
  • Body: Campos a serem atualizados.

DELETE /users

  • Descrição: Excluir a conta do usuário autenticado.
  • Método HTTP: DELETE
  • Autenticação: Token JWT necessário.

GET /users/search/:query

  • 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.

PATCH /users/follow/:id

  • 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.

PATCH /users/unfollow/:id

  • 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.

Arquivos

POST /files

  • Descrição: Fazer upload de arquivos.
  • Método HTTP: POST
  • Autenticação: Token JWT necessário.
  • Requisição: Multipart/form-data com o arquivo.

GET /files/:id

  • 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.

DELETE /files/:id

  • 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.

Posts

POST /posts

  • Descrição: Criar um novo post.
  • Método HTTP: POST
  • Autenticação: Token JWT necessário.
  • Body: Campos do post.

GET /posts

  • Descrição: Obter todos os posts.
  • Método HTTP: GET
  • Autenticação: Token JWT necessário.

GET /posts/:userId

  • 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.

PATCH /posts/:postId/like

  • Descrição: Curtir um post.
  • Método HTTP: PATCH
  • Autenticação: Token JWT necessário.
  • Parâmetros URL: postId (string): ID do post.

PATCH /posts/:postId/unlike

  • 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.

DELETE /posts/:postId

  • Descrição: Excluir um post.
  • Método HTTP: DELETE
  • Autenticação: Token JWT necessário.
  • Parâmetros URL: postId (string): ID do post.

PATCH /posts/:postId/comment

  • 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.

campus-connect-server's People

Contributors

bruno-brandao-silva avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.