/exemplo-restful-nodejs

RESTful com Node.js, Restify e MySQL

Primary LanguageJavaScriptMIT LicenseMIT

RESTful com Node.js, Restify e MySQL

Update: 20.08.2017

Este projeto foi desenvolvido durante a gravação da série de screencasts disponível em https://www.youtube.com/playlist?list=PLFJmwzuHdBRTBbkyH0gATtDhj6ikOIkMy e é pré-requisito para o curso Single Page Application com Vue.js http://www.treinatom.com.br/pt/edukee/detalhes-do-evento/190edc6b7593e3081a858f55652abd92a9d07353

Pré-requisitos

  • Node.js versão 8 ou superior;
  • Nodemon - npm i -g nodemon.

Instalação

  1. Faça o clone do repositório e no terminal navegue até a pasta;
  2. Instale as dependências do projeto com npm install;
  3. Rode o servidor de desenvolvimento com npm run dev.
  4. Edite o arquivo /src/services/mysql/index.js e adicione as suas próprias configurações de conexão com o MySQL. Não se esqueça de criar o banco de dados e a tabela:
mysql -u <usuario> -p

mysql> create database restful_ws character set utf8 collate utf8_general_ci

mysql> create table categories (id INT(11) unsigned not null auto_increment, name VARCHAR(255), primary key(id));

mysql> insert into categories (name) values ('Categoria 01');
mysql> insert into categories (name) values ('Categoria 02');

- USERS:
create table users (id INT(11) unsigned not null auto_increment, email varchar(255), password varchar(40), primary key(id));
  1. O endpoint do serviço estará disponível em http://localhost:3456 .

Sugestão

Utilize o Postman para testar suas chamadas. https://www.getpostman.com/.

Estrutura de Pasta

├── restful-ws
|   ├── node_modules (não será importado, rodar npm install)
|   ├── src
|       ├── http
|           ├── routes.js
|       ├── server
|           ├── cors.js
|           ├── index.js
|       ├── services
|           ├── mysql
|               ├── categories.js
|               ├── index.js
|   ├── .eslintrc.json
|   ├── package-lock.json
|   ├── package.json
|   ├── README-JR.md
|   ├── README.md

Métodos API : Usarem o Postman para facilitar os testes

URL:

http://localhost:3456/categoria

Method: GET

Method: POST

parameters: 
name

Method: PUT

parameters: 
name
id

Method: DELETE

parameters: 
id

Versionalização

  • Para melhor organização seguiremos as diretrizes da Versionalização semântica - 1.0.0

License

MIT©2017 farnetani

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.