docs/index.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Home</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Home</h1>
<h3> </h3>
<section>
<article><p align="center">
<img src="https://estudiodigitalbocca.com.br/edb-logo.svg" width="200px">
<p align="center">Ultima Atualização na v0.17.0</p>
<h1 align="center">edb-response</h1>
<h4 align="center">
Formatação padrão EDB para resposta de API Rest
</h4>
<p align="center">
<img src="https://badgen.net/badge/version/v0.17.0/orange">
<a href="https://codeclimate.com/github/digitalbocca/edb-response/maintainability">
<img src="https://api.codeclimate.com/v1/badges/099992aed09bb6cb59e9/maintainability">
</a>
<a href="https://estudiodigitalbocca.com.br">
<img src="https://badgen.net/badge/produto/EDB/f19b2c">
</a>
<a href="https://standardjs.com">
<img src="https://badgen.net/badge/code%20style/standard/yellow">
</a>
<a href="https://www.npmjs.com/package/edb-response">
<img src="https://badgen.net/npm/v/edb-response">
</a>
<a href="https://www.npmjs.com/package/edb-response">
<img src="https://badgen.net/npm/license/edb-response">
</a>
<a href="https://www.npmjs.com/package/edb-response">
<img src="https://badgen.net/npm/dt/edb-response">
</a>
<a href="https://github.com/digitalbocca/edb-response">
<img src="https://badgen.net/github/tag/digitalbocca/edb-response">
</a>
<a href="https://www.npmjs.com/package/edb-response">
<img src="https://badgen.net/david/dep/digitalbocca/edb-response">
</a>
<a href="https://www.npmjs.com/package/edb-response">
<img src="https://badgen.net/david/dev/digitalbocca/edb-response">
</a>
<a href="https://www.npmjs.com/package/edb-response">
<img src="https://badgen.net/packagephobia/install/edb-response">
</a>
<a href="https://www.npmjs.com/package/edb-response">
<img src="https://badgen.net/packagephobia/publish/edb-response">
</a>
<a href="https://www.npmjs.com/package/edb-response">
<img src="https://badgen.net/bundlephobia/min/edb-response">
</a>
<a href="https://www.npmjs.com/package/edb-response">
<img src="https://badgen.net/bundlephobia/minzip/edb-response">
</a>
</p>
<p align="center">
<a href="https://github.com/standard/standard">
<img src="https://cdn.rawgit.com/standard/standard/master/badge.svg">
</a>
</p>
<p align="center">(c)2020-2021 Estúdio Digital Bocca</p>
</p>
<hr>
<h1>edb-response - README</h1>
<hr>
<h2>ATENÇÃO</h2>
<p>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.</p>
<h2>EXEMPLO DE USO</h2>
<ul>
<li>Adicione a Dependência:</li>
</ul>
<pre class="prettyprint source lang-bash"><code>npm install --save edb-response
</code></pre>
<ul>
<li>Importe no arquivo que vai enviar a resposta:</li>
</ul>
<pre class="prettyprint source lang-js"><code>const edbResponse = require('edb-response')
</code></pre>
<ul>
<li>Monte a resposta e faça o envio:</li>
</ul>
<pre class="prettyprint source lang-js"><code>edbResponse.resposta(200, 'Título da Resposta', { msg: 'Tudo OK' }, req, res)
</code></pre>
<ul>
<li>Parâmetros Comentados:</li>
</ul>
<pre class="prettyprint source lang-js"><code>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
)
</code></pre>
<ul>
<li>Resposta para este exemplo:</li>
</ul>
<pre class="prettyprint source lang-json"><code>{
"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"
}
</code></pre>
<blockquote>
<p>OBS: <strong>apiVersion</strong> pega os dados da env process.env.VER</p>
<p>OBS: <strong>backend</strong> pega os dados da env process.env.BACK</p>
</blockquote>
<h2>REGISTRO DE ALTERAÇÕES</h2>
<ul>
<li>Veja no arquivo <a href="CHANGELOG.md">CHANGELOG</a></li>
</ul>
<h2>LICENÇA</h2>
<ul>
<li>MIT</li>
</ul>
<blockquote>
<p>(c)2018-2021 - Estúdio Digital Bocca - <a href="https:%5C/%5C/estudiodigitalbocca.com.br">https://estudiodigitalbocca.com.br</a></p>
</blockquote></article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-edbResponse.html">edbResponse</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Fri Apr 30 2021 09:25:29 GMT-0300 (Horário Padrão de Brasília)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>