Giter Club home page Giter Club logo

json-server-base's Introduction

json-server-base

Esse é o repositório com a base de JSON-Server + JSON-Server-Auth para ser usada no desenvolvimento da API de cursos.

Endpoints

Assim como a documentação do JSON-Server-Auth traz (https://www.npmjs.com/package/json-server-auth), existem 3 endpoints que podem ser utilizados para cadastro e 2 endpoints que podem ser usados para login. Adicionalmente há 2 endpoints para iniciar, contendo a lista de cursos e a lista de disciplinas.

Cadastro

POST /register
POST /signup
POST /users

Formato da requisição:

{
  "email": "[email protected]",
  "password": "123456",
  "name": "Kenzinho",
  "age": 38
}

Formato da resposta:

{
  "email": "[email protected]",
  "password": "$2a$10$YQiiz0ANVwIgpOjYXPxc0O9H2XeX3m8OoY1xk7OGgxTnOJnsZU7FO",
  "name": "Kenzinho",
  "age": 38,
  "id": 1
}

Qualquer um desses 3 endpoints irá cadastrar o usuário na lista de "Users", sendo que os campos obrigatórios são os de email e password. Você pode ficar a vontade para adicionar qualquer outra propriedade no corpo do cadastro dos usuários.

Login

POST /login
POST /signin

Qualquer um desses 2 endpoints pode ser usado para realizar login com um dos usuários cadastrados na lista de "Users"

Formato da requisição:

{
  "email": "[email protected]",
  "password": "123456",
  "name": "Kenzinho",
  "age": 38
}

Formato da resposta:

{
  "email": "[email protected]",
  "password": "$2a$10$YQiiz0ANVwIgpOjYXPxc0O9H2XeX3m8OoY1xk7OGgxTnOJnsZU7FO",
  "name": "Kenzinho",
  "age": 38,
  "id": 1
}

Curso

Quando logado, você cria seu curso para poder ter acesso à quais disciplinas quer adicionar

Ver todos os cursos:

GET /courses

Formato da resposta:

[
  {
    "course_name": "front end developer",
    "course_description": "developing for the future",
    "id": 1
  },
  {
    "course_name": "backend end developer",
    "course_description": "backing to the future",
    "id": 2
  }
]

Adicionar curso:

POST /courses

Formato de envio do JSON:

{
  "course_name": "backend end developer",
  "course_description": "backing to the future",
  "userId: 2"
}

Formato da resposta:

{
  "course_name": "backend end developer",
  "course_description": "backing to the future",
  "userId: 2"
  "id": 3
}

Atualizar curso:

PATCH /courses/:course_id

Formato de envio do JSON:

{
  "course_description": "new description"
}

Formato da resposta:

{
  "course_description": "new description"
}

Excluir cursos:

DELETE /courses/:course_id
Nota: não é necessário um corpo da requisição (JSON)

Disciplina

Quando logado, você cria sua disciplinas para poder associar aos cursos (você também pode consultar todas as disciplinas mesmo não logado)

Ver todas as disciplinas:

GET /disciplinas

Formato da resposta:

[
  {
    "discipline_name": "react",
    "discipline_description": "create interfaces",
    "id": 1
  },
  {
    "discipline_name": "node",
    "discipline_description": "build scalable applications",
    "id": 2
  }
]

Adicionar disciplina:

POST /disciplinas

Formato de envio do JSON:

{
  "discipline_name": "react",
  "discipline_description": "create interfaces"
}

Formato da resposta:

{
  "discipline_name": "react",
  "discipline_description": "create interfaces",
  "id": 1
}

Atualizar disciplina:

PATCH /disciplinas/:discipline_id

Formato de envio do JSON:

{
  "discipline_description": "new description"
}

Formato da resposta:

{
  "discipline_description": "new description"
}

Excluir disciplinas:

DELETE /disciplinas/:discipline_id
Nota: não é necessário um corpo da requisição (JSON)

json-server-base's People

Contributors

raf2019 avatar ivanborba 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.