Code Monkey home page Code Monkey logo

api-de-games-docs's Introduction

API de Games

Está API é utilizada para gerenciar os games cadastrados, além de realizar uma autenticação do usuário.

Endpoints

GET /games

Esse endpoint é responsável por retornar a listagem de todos os games cadastrados no banco de dados.

Parâmetros

Nenhum.

Respostas

OK! 200

Caso essa resposta aconteça, você vai receber a listagem de todos os games.
Exemplo de resposta:

[
    {
        "id": 5,
        "title": "GTA V",
        "price": 120,
        "year": 2006,
        "createdAt": "2020-09-03T21:40:08.000Z",
        "updatedAt": "2020-09-03T22:15:03.000Z"
    },
    {
        "id": 6,
        "title": "The King of Fighters",
        "price": 190,
        "year": 2002,
        "createdAt": "2020-09-05T01:40:50.000Z",
        "updatedAt": "2020-09-05T01:41:01.000Z"
    }
]
Falha na autenticação! 401

Caso essa resposta aconteça, significa que aconteceu alguma falha durante o processo de autenticação da requisição. Motivos: E-mail ou senha inválidos.
Exemplo de resposta:

{
    "error": "Token inválido."
}

POST /auth

Esse endpoint é responsável por fazer o processo de login.

Parâmetros

email: E-mail do usuário cadastrado no sitema.
password: Senha do usuário cadastrado no sistema.
Exemplo:

{
   "email": "[email protected]",
   "password": "0000"
}

Respostas

OK! 200

Caso essa resposta aconteça, você vai receber o token JWT para ter acesso aos endpoints protegidos pela API.
Exemplo de resposta:

{
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwiZW1haWwiOiJ1c3VhcmlvQGdtYWlsLmNvbSIsImlhdCI6MTU5OTI3NTI2MiwiZXhwIjoxNTk5NDQ4MDYyfQ.oAVKzcanUoOq8WxKLw0In7DDGTXlMeKhqOtVYyroe_4"
}
Falha na autenticação! 401

Caso essa resposta aconteça, significa que aconteceu alguma falha durante o processo de autenticação da requisição. Motivo: Token inválido / Token expirado.
Exemplo de resposta:

{
    "error": "Credenciais inválidas."
}

api-de-games-docs's People

Contributors

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