digitalbocca/edb-response

Formatação Padrão EDB para respostas de api.

Ultima Atualização na v0.17.0

edb-response

Formatação padrão EDB para resposta de API Rest

(c)2020-2021 Estúdio Digital Bocca

---

edb-response - README

---

ATENÇÃO

Este modulo não é um middleware. Ele formata e envia a resposta e deverá ser utilizado no ultimo estágio da API, apenas para enviar a resposta.

EXEMPLO DE USO

• Adicione a Dependência:

npm install --save edb-response

• Importe no arquivo que vai enviar a resposta:

const edbResponse = require('edb-response')

• Monte a resposta e faça o envio:

edbResponse.resposta(200, 'Título da Resposta', { msg: 'Tudo OK' }, req, res)

• Parâmetros Comentados:

edbResponse.resposta(
  200,                  // http status code
  'Título da Resposta', // Um título descritivo da resposta
  {
    msg: 'Tudo OK'      // Objeto de resposta
  },                    // (response.data.dados contém este objeto)
  req,                  // Objeto de request do express
  res                   // Objeto de response do express
)

• Resposta para este exemplo:

{
  "status":200,
  "msg":"Título da Resposta",
  "dados": {
    "msg": "Tudo OK"
  },
  "apiVersion": "v0.17.0",
  "backend": "Nome do Sistema",
  "copyright": "(c)2021 Estúdio Digital Bocca"
}

OBS: apiVersion pega os dados da env process.env.VER

OBS: backend pega os dados da env process.env.BACK

REGISTRO DE ALTERAÇÕES

• Veja no arquivo CHANGELOG

LICENÇA

• MIT

(c)2018-2021 - Estúdio Digital Bocca - https://estudiodigitalbocca.com.br