Giter Club home page Giter Club logo

api-incidents's Introduction

Documentação da API

Esta é uma API simples construída com Node.js e Express, que utiliza autenticação JWT (JSON Web Tokens) para proteger rotas específicas. A API permite a criação, leitura, atualização e exclusão de incidentes, além de fornecer informações sobre o servidor onde está hospedada.

Rotas

Autenticação

  • POST /login
    • Esta rota permite autenticar um usuário e receber um token JWT válido para acesso às demais rotas protegidas.
    • Body:
      {
        "username": "admin",
        "password": "admin"
      }
    • Resposta de Sucesso:
      {
        "token": "token_jwt"
      }

Incidentes

  • GET /incidents

    • Retorna uma lista de todos os incidentes cadastrados.
    • Requer autenticação JWT.
  • POST /incidents

    • Cria um novo incidente.
    • Body:
      {
        "title": "Título do Incidente",
        "description": "Descrição detalhada do incidente",
        "leak": "Tipo de vazamento",
        "severity": "Severidade do incidente"
      }
    • Requer autenticação JWT.
  • PUT /incidents/:id

    • Atualiza um incidente existente.
    • Parâmetros de Rota:
      • id: ID do incidente a ser atualizado.
    • Body:
      {
        "title": "Novo Título",
        "description": "Nova descrição",
        "leak": "Novo tipo de vazamento",
        "severity": "Nova severidade"
      }
    • Requer autenticação JWT.
  • DELETE /incidents/:id

    • Exclui um incidente existente.
    • Parâmetros de Rota:
      • id: ID do incidente a ser excluído.
    • Requer autenticação JWT.

Informações do Servidor

  • GET /server-info
    • Retorna informações sobre o servidor onde a API está hospedada, como nome do host, tempo de atividade, memória total e livre, carga média do sistema, informações da CPU e interfaces de rede.

Configuração

  1. Instale as dependências:
    npm install
    
  2. Execute a aplicação:
    node app.js
    
    A aplicação será executada na porta especificada (padrão: 3000).
    

Pré-requisitos

  • Node.js e npm instalados na máquina.

api-incidents's People

Contributors

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