Geen omschrijving

Pablo Barrera Yaksic 0a894b9124 updated README 7 maanden geleden
lib 9e79af4a95 First commit 7 maanden geleden
src 9e79af4a95 First commit 7 maanden geleden
.eslintrc.json 9e79af4a95 First commit 7 maanden geleden
.gitignore 9e79af4a95 First commit 7 maanden geleden
README.md 0a894b9124 updated README 7 maanden geleden
index.d.ts 9e79af4a95 First commit 7 maanden geleden
package-lock.json 9e79af4a95 First commit 7 maanden geleden
package.json 9e79af4a95 First commit 7 maanden geleden
tsconfig.json 9e79af4a95 First commit 7 maanden geleden

README.md

#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)