Git Product home page Git Product logo

restful-api's Introduction

restful-api

RESTful API usando Node.js and Express 4

Resumo

Este projeto foi desenvolvido para as disciplinas de Criação de Aplicações Web Apps e Tec. Server-side com Node.js, da pós-graduação em DESIGN WEB APPS COM TECNOLOGIA FRONT-END, no INSTITUTO BRASILEIRO DE EXPERTISE PROFISSIONAL.

Serão passadas aqui instruções que permitirão obter uma cópia do projeto e executar o mesmo.

Como Usar

Pré-requisitos

O que você precisa para instalar e rodar o projeto:

  1. Git (^2.8.1) - https://git-scm.com/
  2. Node.js (^6.9.4) e NPM (^3.10.10) - https://nodejs.org/
  3. MongoDB (^3.2.11) - https://www.mongodb.com/

Instalando

Um passo a passo...

  1. Execute o comando git clone para download dos fontes deste repositório;
  2. Vá para a pasta do projeto e execute o comando npm install;
  3. Vá para a pasta parameters and atribua os valores de configuração desejados para os arquivos authentication.js, database.js, encryption.js e infrastructure.js;
  4. Vá para a pasta raiz do projeto e execute o comando npm start.

API no Heroku

Para facilitar, a API foi hospedada no Heroku.

Você também pode testar e usar esta API por meio da URL: https://restful-api-dwa.herokuapp.com.

Rotas

As seguintes rotas estão disponíveis:

Autenticação

/authentication

Rota para autenticação de usuários. Use o método HTTP POST, passando no body da requisição o email e a senha do usuário. Como resposta, para uma autenticação bem sucedida, será retornado o token de acesso.

Produtos

/products

Rota para listagem dos produtos. Use o método HTTP GET. Não é necessário passar token da acesso.

Você pode testar com a seguinte URL: https://restful-api-dwa.herokuapp.com/products.

/products/{_id}

Rota para consulta de um produto específico. Use o método HTTP GET. Não é necessário passar token da acesso.

Itens

/items

Rota para listagem dos itens que formam alguns produtos. Use o método HTTP GET. Não é necessário passar token da acesso.

Você pode testar com a seguinte URL: https://restful-api-dwa.herokuapp.com/items.

/items/{_id}

Rota para consulta de um item de produto específico. Use o método HTTP GET. Não é necessário passar token da acesso.

Licença

MIT License (MIT).

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.