mesaugat / express-api-es6-starter Goto Github PK

Build APIs with Express.js in no time using ES6/ES7/ESNext goodness.

Home Page: https://express-api-es6-starter.herokuapp.com/api-docs/

License: MIT License

JavaScript 95.65% Dockerfile 4.35%

api babel es2015 es2017 expressjs nodejs rest web

express-api-es6-starter's Introduction

express-api-es6-starter's People

Contributors

Stargazers

Watchers

Forkers

squgeim pratishshr sureshshrestha tdavincci derickwarshaw ecliptik alemp martenwibom blesspow dncahyo coyg7 tidusvn05 chanoch cerberusv2px johnzon 20b2 luongvanphuc russll alextrigo javaallah pxson2903 ceiger89 solarsoft0 sachit-singh sanjaymhj qopqopqop henryemekaonuorah92 samirpdl pravashupreti greyme su-sh impuneet bibekshakya35 hamiasmai08 pdembiermont dengdan99 tulipden712 lamngockhuong hudsonsza tforsberg hadirsa godzillafiw omar-dulaimi kabirbaidhya eofafrica4lyf paulkagiri shradayshakya ricardohcastro sanjevshakya anthonylaw henoktes72 donleqt amritghimire helloganjian carlo23666 prajwaldankit thoonly webheavens tiwarirabi b7rexx zaing dipsonshahi bikramsinkemana samhou1988 thecredibleinc tenwiz maskeynihal prajwalrajbasnet biletskiy6 pattaradanai dafecueto wildanadt jamesdwalker sameer-coder akash-shrestha aakashbhusal7 chaudharynabin6 pakinwet timmyisanerd mohmdio airondev alphavariable shirodkarpushkar akaradat primweb thesouthsea sumitkakshapati yicheng55 gislayer

express-api-es6-starter's Issues

Move swagger-jsdoc to a separate directory

Create a separate directory for swagger-docs

Show error message on 500

How can I show that error message on console in my return ?

2017-12-16T11:03:36.598Z - error: Error: ER_NO_SUCH_TABLE: Table 'sigpharmaDB1.tipos_medicamentos' doesn't exist

Swagger info as yml

Why are the swagger info in src/docs as jsdoc? Why not just use yaml? Wouldn't that be simpler and easier to write?

Remove bookshelf and just use knex for database operations

Use babel-preset-env

Remove 'babel-preset-2015', 'babel-preset-2016', 'babel-preset-2017' and instead use 'babel-preset-env'

https://babeljs.io/env/

What about pagination

how can I use pagination to get my records from some api resource ?

Get the correct error message when transaction fails

Hey,
how can I get the correct error message when my transaction fails. The correct message is where this arrow is showing.

I want to show the message that field is null.


  let pessoa = RecordPessoa;
  let pessoaFisica = RecordPessoaFisica;
  let pessoaJuridica = RecordPessoaJuridica;
  let cliente = Record;

  bookshelf
    .transaction(t => {
      console.log('just trying transaction here ===>');
      // pessoa
      pessoa = {
        tipo_documento: tipoDocumento
      };

      const data = new RecordPessoa(pessoa)
        .save(null, { transacting: t })
        .then(pessoa => {
          if (tipoDocumento === 0) {
            // pessoa fisica
            pessoaFisica = {
              pessoa_id: pessoa.pessoa_id,
              cpf: record.cpf,
              nascimento: record.nascimento,
              nome_1: record.nome_1,
              nome_2: record.nome_2,
              genero: record.genero,
              estado_civil: record.estado_civil,
              identidade: record.identidade,
              orgao_emissor: record.orgao_emissor,
              emissao: record.emissao,
              nacionalidade: record.nacionalidade,
              naturalidade: record.naturalidade
            };
          } else {
            // pessoa juridica
            pessoaJuridica = {
              pessoa_id: pessoa.pessoa_id,
              cnpj: record.cnpj,
              nome_1: record.nome_1,
              nome_2: record.nome_2,
              cnae_id: record.cnae_id,
              crt: record.crt,
              insc_estadual: record.insc_estadual,
              insc_estadual_st: record.insc_estadual_st,
              insc_municipal: record.insc_municipal,
              insc_suframa: record.insc_suframa
            };
          }
          if (tipoDocumento === 0) {
            // grava pessoa fisica
            return new RecordPessoaFisica(pessoaFisica)
              .save(null, { transacting: t })
              .then(pessoaFisica => {
                // cliente
                cliente = {
                  pessoa_id: pessoaFisica.pessoa_id
                };

                return new Record(cliente).save(null, { transacting: t });
              });
          } else {
            // grava pessoa fisica
            return new RecordPessoaJuridica(pessoaJuridica)
              .save(null, { transacting: t })
              .then(pessoaJuridica => {
                // cliente
                cliente = {
                  pessoa_id: pessoaJuridica.pessoa_id
                };

                return new Record(Record).save(null, { transacting: t });
              });
          }
        });
      console.log('==> DATA => ' + JSON.stringify(data));

      return data;
    })
    .then(damba => {
      console.log(JSON.stringify(damba));
    })
    .catch(function (err) {
      console.log('<======= deveria dar ROLL BACK AQUI =======>');

      console.error(err);

      return err;
    });

Add docker

With proper documentation on how to setup/deploy

Unable to migrate

Getting this error while running
npm run migrate:latest

Error: connect ECONNREFUSED 127.0.0.1:5432
at Object.exports._errnoException (util.js:1036:11)
at exports._exceptionWithHostPort (util.js:1059:20)
at TCPConnectWrap.afterConnect [as oncomplete] (net.js:1080:14)

405 Not Allowed

I clone the repo and start my app but when I try to acess http://localhost:8848/ I get

{
    "error": {
        "code": 405,
        "message": "Method Not Allowed"
    }
}

Problem when field name contains numbers

I'm trying to insert some data on my table.
That table has a field called MED_PLA17
But BookShelf dont recognize when I try to set this field

const record = {
   medAbc: resource.ID_PRODUTO,
   medCtr: resource.NOME_FABRICANTE,
   medCap: resource.CAP,
   medTarja: resource.ID_TARJA,
   medAbc: resource.ID_PRODUTO,
   labNom: resource.NOME_FABRICANTE,
   medTipmed: resource.DESCRICAO_TIPO_PRODUTO,
   medDes: resource.NOME,
   medApr: resource.DESCRICAO,
   medPrinci: resource.COMPOSICAO,
   medBarra: resource.EAN,
   medLab: resource.ID_FABRICANTE,
   medNegpos: resource.ID_LCCT,
   medPla17: resource.MED_PLA17
   // medPLA175: resource.PF_17_5,
   // medPLA18: resource.PF_18,
   // medPla_12: resource.PF_12,
   // medPla20: resource.PF_20

 };

 console.log(`${JSON.stringify(record)}`);


 return new Resource(record).save().then(resource => resource.refresh());
{"medAbc":"240402","medCtr":"AUROBINDO PHARMA","medCap":"0","medTarja":"TV","labNom":"AUROBINDO PHARMA","medTipmed":"GENERICO","medDes":"AMPICILINA SODICA","medApr":"500mg po sol inj x 50fa emb hosp","medPrinci":"AMPICILINA SODICA","medBarra":"7898361884611","medLab":"435","medNegpos":"+","medPla17":"125.64"}

The error

2018-04-11T19:19:51.279Z - error:  Error: ER_BAD_FIELD_ERROR: Unknown column 'med_pla_17' in 'field list'

Logger timestamp issue

Date().toLocaleTimeString() doesn't seem to be working in winston

Observed behaviour:

Expected behaviour:

Replace winston with pino for logging

Saving 3 inserts in one post route

How can I insert record in 3 tables (mysql) in one post route ?

I have 3 tables,

table A - id

table B id, a_id
table C id, a_id

I need to create the record on table A and them pass his id to the another tables records.

Debug issue

Hi, first of all, excellent work!

I have a little issue, when you are debugging and save the code nodemon restart correctly but with the same version, this is because its no compiled again, only in the first run, its any way to achive that? i try diffents ways but im stuck.

Thanks!

docker => 'client' is missing

When I try to run it from docker I get
api_1 | Error: knex: Required configuration option 'client' is missing.

api_1  | [4/5] Linking dependencies...
api_1  | [5/5] Building fresh packages...
api_1  | success Saved 1 new dependency.
api_1  | info Direct dependencies
api_1  | └─ [email protected]
api_1  | info All dependencies
api_1  | └─ [email protected]
api_1  | Done in 11.15s.
api_1  | yarn run v1.6.0
api_1  | $ nodemon --watch .env --watch src --exec babel-node src --source-maps
api_1  | [nodemon] 1.12.1
api_1  | [nodemon] to restart at any time, enter `rs`
api_1  | [nodemon] watching: /app/.env/**/* /app/src/**/*
api_1  | [nodemon] starting `babel-node src --source-maps`
api_1  | /app/node_modules/knex/lib/client.js:108
api_1  |     throw new Error('knex: Required configuration option \'client\' is missing.');
api_1  |     ^
api_1  |
api_1  | Error: knex: Required configuration option 'client' is missing.
api_1  |     at new Client (/app/node_modules/knex/lib/client.js:108:11)
api_1  |     at Knex (/app/node_modules/knex/lib/index.js:60:34)
api_1  |     at Object.<anonymous> (/app/src/db.js:8:14)
api_1  |     at Module._compile (module.js:652:30)
api_1  |     at loader (/app/node_modules/babel-register/lib/node.js:144:5)
api_1  |     at Object.require.extensions.(anonymous function) [as .js] (/app/node_modules/babel-register/lib/node.js:154:7)
api_1  |     at Module.load (module.js:565:32)
api_1  |     at tryModuleLoad (module.js:505:12)
api_1  |     at Function.Module._load (module.js:497:3)
api_1  |     at Module.require (module.js:596:17)
api_1  |     at require (internal/module.js:11:18)
api_1  |     at Object.<anonymous> (/app/src/index.js:2:1)
api_1  |     at Module._compile (module.js:652:30)
api_1  |     at loader (/app/node_modules/babel-register/lib/node.js:144:5)
api_1  |     at Object.require.extensions.(anonymous function) [as .js] (/app/node_modules/babel-register/lib/node.js:154:7)
api_1  |     at Module.load (module.js:565:32)

Update FIELDS different than Insert FIELDS

Hi,
I'm using 'bookshelf-camelcase' plugin and that is my model class

import bookshelfR from '../../../../db_R';

const TABLE_NAME = 'tipo_medicamento';
class tipoMedicamento extends bookshelfR.Model {
  get idAttribute() {
    return 'codigoTipoMedicamento';
  }
  get tableName() {
    return TABLE_NAME;
  }
}
export default tipoMedicamento;

I can succes insert a new record using that function createResource and passing this as parameters:

Parameters

{
	"codigoTipoMedicamento": null,
	"descricao": "Problemas diversos", 
	"codigoBig": "atualizando registro 8"
}

Function

export function createResource(resource) {

  return new Resource({
    descricao: resource.descricao,
    codigoBig: resource.codigoBig
  })
    .save()
    .then(resource => {
      resource.refresh();
      return resource;
    });
}

But when I try to UPDATE my record, using this parameters and function I get some error about the primarykey field name is incorrect:

Parameters to updateRecord function

{
	"codigoTipoMedicamento": null,
	"descricao": "Problemas diversos", 
	"codigoBig": "atualizando registro 8"
}

Function updateRecord

export function updateResource(codigoTipoMedicamento, resource) {
  const data = {
    descricao: resource.descricao,
    codigoBig: resource.codigoBig
  };

  return new Resource({
    codigoTipoMedicamento
  })
    .save(data)
    .then(resource => resource.refresh());
}

table structure in mysql/mariadb

The ERROR:


 error:  Error: ER_BAD_FIELD_ERROR: Unknown column 'codigoTipoMedicamento' in 'where clause'
    at Query.Sequence._packetToError (/home/duard/projetoSIG/sigpharmaAPI/node_modules/mysql/lib/protocol/sequences/Sequence.js:52:14)
    at Query.ErrorPacket (/home/duard/projetoSIG/sigpharmaAPI/node_modules/mysql/lib/protocol/sequences/Query.js:77:18)
    at Protocol._parsePacket (/home/duard/projetoSIG/sigpharmaAPI/node_modules/mysql/lib/protocol/Protocol.js:279:23)
    at Parser.write (/home/duard/projetoSIG/sigpharmaAPI/node_modules/mysql/lib/protocol/Parser.js:76:12)
    at Protocol.write (/home/duard/projetoSIG/sigpharmaAPI/node_modules/mysql/lib/protocol/Protocol.js:39:16)
    at Socket.<anonymous> (/home/duard/projetoSIG/sigpharmaAPI/node_modules/mysql/lib/Connection.js:103:28)
    at Socket.emit (events.js:160:13)
    at addChunk (_stream_readable.js:269:12)
    at readableAddChunk (_stream_readable.js:256:11)
    at Socket.Readable.push (_stream_readable.js:213:10)
    at TCP.onread (net.js:599:20)

How to connect with mongodb in this setup?

Hi Thanks for the whole setup.

but I am not able to connect to mongodb with this.

Please help

Support building docker image for both development and prod deployment

Support building docker image for both development and prod deployment.

The dockerfile right now looks more of a development only image. Would be better if we have a build time ability to build an image for prod as well.

Will do a PR.

Add test coverage using istanbul

Generate a test coverage report

Strange return after createrecord

When I run this code

export function createResourceFromAbcFarma(resource) {

  return new Resource({
    med_Abc: resource.ID_PRODUTO,
    med_Ctr: resource.NOME_FABRICANTE,
    med_Cap: resource.CAP,
    med_Tarja: resource.ID_TARJA,
    lab_Nom: resource.NOME_FABRICANTE,
    med_Tipmed: resource.DESCRICAO_TIPO_PRODUTO,
    med_Des: resource.NOME,
    med_Apr: resource.DESCRICAO,
    med_Princi: resource.COMPOSICAO,
    med_Barra: resource.EAN,
    med_Lab: resource.ID_FABRICANTE,
    med_Negpos: resource.ID_LCCT,
    med_pla17: resource.MED_PLA17,
    med_pla175: resource.PF_17_5,
    med_pla18: resource.PF_18,
    med_pla12: resource.PF_12,
    med_pla20: resource.PF_20
  })
    .save()
    .then(resource => {
      console.log(`Inserindo ${JSON.stringify(resource.refresh())}`);
      return resource;
    });
}

The record is inserted on my table, but resource.refresh() result in :

Inserindo {"isFulfilled":false,"isRejected":false}

404 Not Found has not been implemented

In src/index.js, the last middleware to fallback to is methodNotAllowed. This throws a 405. Shouldn't the fallback be 404, at least for a GET request? There already is a notFoundError implemented in middlewares/errorHandler.

2 more fields returning

After a post, the return shows 2 more fields, what is that ? I dont have that fields in my model
{
"data": {
"descricao": "Estamos cadastrando um registro",
"big": "132165484655456",
"updated_at": "2017-12-16T11:11:28.363Z",
"created_at": "2017-12-16T11:11:28.363Z",
"id": 1,
"createdAt": "2017-12-16T08:11:28.000Z",
"updatedAt": "2017-12-16T08:11:28.000Z"
}
}

here is my migration

/**
 * Create tipos_medicamentos table.
 *
 * @param  {object} knex
 * @return {Promise}
 */
export function up(knex) {
  return knex.schema.createTable('tipos_medicamentos', table => {
    table.increments();
    table
      .timestamp('created_at')
      .notNull()
      .defaultTo(knex.raw('now()'));
    table.timestamp('updated_at').notNull();
    table.string('descricao', 255).notNull();
    table.string('big', 255);
  });
}

/**
 * Drop tipos_medicamentos table.
 *
 * @param  {object} knex
 * @return {Promise}
 */
export function down(knex) {
  return knex.schema.dropTable('tipos_medicamentos');
}

async / await on controllers

Why you dont use async / await on controllers ?

/**
 * GET /api/users
 */
router.get('/', (req, res, next) => {
try { 
  resources = userService.getAllUsers();
  return resources;
} catche(error) {
  res.json(error);
});

Move to GitHub actions

Lint files before staging it to git

Use something like lint-staged or husky
Check out prettier too

New Migrate

What is the way to generate ES6 migrations from knex ?
I try to create a new migration but it looks diferent

**knex migrate:make usuarios** 

exports.up = function(knex, Promise) {
  
};

exports.down = function(knex, Promise) {
  
};

Add a migration stage to Dockerfile

Need to run the migrations in the Dockerfile as well as update the README with information about Docker multi-stage build/deployment.

Add prettier to the project

Prettier formatting is controversial but I believe is one of the most "agreeable" formattings out there, and that the whole of Facebook's source has been moved to it is a strong point.

Besides, formatting will always be a case of taste and that will defer from person to person. This usually leads to conflicts between people in a code review (comments like "put a space after if" and another "don't put a space after if").

Arguing about formatting in a code review takes the focus away from the actual code, and to how the code looks to one person.

Adding prettier as a linting rules takes the formatting variable out the code review. Everyone, whether they like it or not, will follow the same rule.