Pablo Barrera Yaksic 5e3d875c0e eslintrc | 7 달 전 | |
---|---|---|
lib | 7 달 전 | |
src | 7 달 전 | |
.eslintrc | 7 달 전 | |
.gitignore | 7 달 전 | |
README.md | 7 달 전 | |
index.d.ts | 7 달 전 | |
package-lock.json | 7 달 전 | |
package.json | 7 달 전 | |
tsconfig.json | 7 달 전 |
#PRAS - Pablo Rest API Standard Instalación
npm install --save git+ssh://pablo@git.pablo.by:pablo/pablo-rest-api-standard.git
Importar la lib
//Import section
import PRAS from 'pablo-rest-api-standard';
Inicializar la app express
const app = express();
//Rest of the code...
Antes de incluir cualquiera de las rutas
app.use(PRAS.responseMiddleware());
app.get('/', (req, res) => {});
//Rest of the code...
En los controladores se tienen metodos auxiliares para los posibles tipos de respuesta, no hay parámetros requeridos.
Respuesta OK PRAS.ok(message, data, code, extra)
Respuesta Creación PRAS.created(message, data, code, extra)
Respuesta parámetros inválidos PRAS.badRequest(message, data, code, extra)
Respuesta autorización requerida PRAS.unauthorized(message, data, code, extra)
Respuesta sin permiso PRAS.forbidden(message, data, code, extra)
Respuesta recurso no encontrado PRAS.notFound(message, data, code, extra)
Respuesta de error en el servidor PRAS.serverError(message, data, code, extra)