rastamansp / dextra

X-CORE - SERVIDOR DE APIS REST

Servidor de APIs REST desenvolvido em Node.js, Express e MongoDB.

Requisitos

• Node.js LTS instalado ( versão >= 6.0 );
• MongoDB instalado ( versão >= 3.2 );

Como usar

Executar os seguintes procedimentos:

PS: Testes Automatizados não implementados

1. Instalar modulos utilizando o comando "npm install" na pasta "./server-express";
2. Iniciar o servidor do MongoDB ( Ex.: mongod --dbpath ~/workspace/data );
3. Executar o comando de import dos dados ( Ex.: mongorestore -d dextra bkp );
4. Executar o "npm start" na pasta "./server".
5. Incluir os codigos fontes das api
6. Executar chamada para conhecer mais sobre o perfil do candidato: GET http://localhost:32000/usuarios/v1/usuarios/
7. Executar chamada de listagem de ingredientes: GET http://localhost:32000/lanches/v1/ingredientes/
8. Escolher algum link do "hateos" para ver detalhes de ingredientes: consultar_ingrediente
9. Ex: http://localhost:32000/lanches/v1/ingredientes/59d403ef88b13b75e73dbc33 (_id podem ser diferentes dependendo das configurações de seu servidor mongodb);
10. Realizar cotação de lanche:

{
    "ingredientes": [
    {
		"id": 3,
		"nome": "Hambúrguer de carne",
		"quantidade": 1
    },
    {
		"id": 1,
		"nome": "Alface",
		"quantidade": 1
    },
    {
    	"id": 5,
		"nome": "Queijo",
		"quantidade": 1
    }]
}

Alguns exemplos: X-Bacon

{
    "ingredientes": [
    {
		"id": 3,
		"nome": "Hambúrguer de carne",
		"quantidade": 1
    },
    {
		"id": 2,
		"nome": "Bacon",
		"quantidade": 1
    },
    {
    	"id": 5,
		"nome": "Queijo",
		"quantidade": 1
    }]
}

X-burger

{
    "ingredientes": [
    {
		"id": 3,
		"nome": "Hambúrguer de carne",
		"quantidade": 1
    },
    {
    	"id": 5,
		"nome": "Queijo",
		"quantidade": 1
    }]
}

X-Egg

{
    "ingredientes": [
    {
		"id": 3,
		"nome": "Hambúrguer de carne",
		"quantidade": 1
    },
    {
    	"id": 4,
		"nome": "Ovo",
		"quantidade": 1
    },
    {
    	"id": 5,
		"nome": "Queijo",
		"quantidade": 1
    }]
}

X-Egg Bacon

{
    "ingredientes": [
    {
		"id": 3,
		"nome": "Hambúrguer de carne",
		"quantidade": 1
    },
    {
		"id": 2,
		"nome": "Bacon",
		"quantidade": 1
    },
    {
    	"id": 4,
		"nome": "Ovo",
		"quantidade": 1
    },
    {
    	"id": 5,
		"nome": "Queijo",
		"quantidade": 1
    }]
}

9. Realizar cotação de lanche: Alterando quantidades para Assumir descontos: Ex com todos descontos:

{
    "ingredientes": [
        {
		"id": 3,
		"nome": "Hambúrguer de carne",
		"quantidade": 4
    },
    {
		"id": 1,
		"nome": "Alface",
		"quantidade": 1
    },
    {
    	"id": 5,
		"nome": "Queijo",
		"quantidade": 3
    }]
}

Retorno esperado:

{
    "data": {
        "valor": 10.259999999999998,
        "ingredientes": [
            {
                "_id": "59d403ef88b13b75e73dbc33",
                "id": 1,
                "nome": "Alface",
                "valor": 0.4,
                "__v": 0,
                "quantidade": 1
            },
            {
                "_id": "59d4041f88b13b75e73dbc35",
                "id": 3,
                "nome": "Hambúrguer de carne",
                "valor": 3,
                "__v": 0,
                "quantidade": 4
            },
            {
                "_id": "59d4043d88b13b75e73dbc37",
                "nome": "Queijo",
                "id": 5,
                "valor": 1.5,
                "__v": 0,
                "quantidade": 3
            }
        ],
        "descontos": [
            {
                "tipo": "Muita carne",
                "valor": 4
            },
            {
                "tipo": "Muito queijo",
                "valor": 1.5
            },
            {
                "tipo": "Light",
                "valor": "10%"
            }
        ]
    }
}

10. Para realizar alterações dos valores de ingredientes basta realizar uma chamada PUT http://localhost:32000/lanches/v1/ingredientes/59d403ef88b13b75e73dbc33 enviando chamada similar a:

{
    "id": 1,
    "nome": "Alface",
    "valor": 0.5
}

11. Para rodar testes automatizados executar comando npm test
12. Para rodar cobertura de testes automatizados rodar "npm start test-cover" 12.1 Necessário ter instalado Istambul(https://istanbul.js.org/) (Para instalar executar: npm i nyc -g)

Recursos

• Mongoose instalado e configurado;
• MongoDB driver nativo instalado e configurado;
• Autenticação JWT instalado e configurado;
• Pasta de APIs REST separado do resto do motor;
• Pasta /public com arquivos estaticos (html, css, js, etc...).

Configurações da API

Na pasta "api_rest" deve conter a pasta que terá o codigo fonte da API.
Ex.: ./api_rest/route-teste-v1-teste-get.
Dentro precisa conter um arquivo "package.json" com os seguintes parametros:

{  
 "name": "route-testes-v1-testes-get",  
 "description": "Api de testes",  
 "version": "1.0.0",  
 "author": "@douglaspands",  
 "type": "api-rest",  
 "route": "/testes/v2/testes",  
 "method": "GET",  
 "controller": "v1/index.js",  
 "auth": true,
 "profile": ['user']
}

• name : Nome da pasta da api;
• description : Descrição da api;
• version : Versão da api;
• author : Autor da api;
• type : Sempre "api-rest";
• route : Rota da api;
• method : Metodo de execução da api;
• controller : Nome do arquivo com a função: module.exports.controller;
• auth : "true" pra quando a api precisa de validação via token. Caso contrario, preencher com "false";
• profile : Lista de perfis de usuarios que podem utilizar essa api.
  Essa propriedade pode ser omitida. Mas se vir preenchida, é aceito das duas maneras abaixo:
  • "profiles": "user"
  • "profiles": ["user", "admin"]

A API tendo o arquivo package.json preenchido, o motor de APIs reconhece ela.

Contribuintes

• @douglaspands
• @pedroalmeida

Versão

• 0.18.3 (beta)