Detalhes das rotas para categoria - eduardosdl/LibraryAPI GitHub Wiki

  • Rota para criação de categoria

       Método POST - https://localhost:3000/category/new
    • Privacidade da rota
       - Acessível apenas para administradores
    • Informações que devem ser enviadas
       {
      "name": "<nome_da_categoria>"
   }
    • Informações que constaram na resposta
       {
      "msg": "Categoria criada com sucesso",
      "data": {
         "name": "<nome_da_categoria>"
      }
   }

  • Rota para resgatar todas as categorias

       Método GET - https://localhost:3000/category
    • Privacidade da rota
       - Acessível apenas para usuários conectados
    • Informações que constaram na resposta
       {
      {
         "_id": "<id>",
         "name": "<nomea>",
         "__v": <versão>
      },
      {
         "_id": "<id>",
         "name": "<nome>",
         "__v": <versão>
      }
   }

  • Rota para resgatar uma categoria específica

       Método GET - https://localhost:3000/category/<nome_da_categoria>
    • Privacidade da rota
       - Acessível apenas para usuários conectados
    • Informações que constaram na resposta
       {
      "category": {
         "_id": "<id>",
         "name": "<nome>",
         "__v": <versão>
      },
      "quantity": <numero_de_livros>,
      "books": [<informções_dos_livros>]
   }

  • Rota para editar uma categoria

       Método PUT - https://localhost:3000/category/edit/<id_da_categoria>
    • Privacidade da rota
       - Acessivel apenas para administradores
    • Informações que devem ser enviadas
       {
      "name": "<novo_nome>"
   }
    • Informações que constaram na resposta
       {
      "msg": "Atualização feita com sucesso"
      "oldData": {
         "name": "<nome_antigo>"
      },
      "newData": {
         "name": <novo_nome>,
      }
   }

  • Rota para apagar uma categoria

       Método DELETE - https://localhost:3000//category/del/<id_da_caetegoria>
    • Caso tenha livros cadastrados nessa categoria ira acusar o seguinte erro
       {
      "msg": "Não é possível apagar a categoria"
   }
    • Se quiser forçar a ação deve ser enviado mais um parâmetro da seguinte forma:
       https://localhost:3000/category/del/<id_da_caetegoria>/?force=true

    ATENÇÃO: Se essa for a opção escolhida os livros serão apagados juntamente com a categoria

    • Privacidade da rota
       - Acessível apenas para administradores
    • Informações que constaram na resposta
       {
      "msg": "Categoria apagada com sucesso",
      "data": {
         "_id": "<id>",
         "name": "<nome>",
         "__v": <versão>
      },
      "deleted_books": <numero_de_livros_apagados>
   }
⚠️ **GitHub.com Fallback** ⚠️