ministerio-server

REST API Server for Ministerio de Educacion.

Table of contents

1. Getting Started
   1. Installation
   2. Database
   3. Loggin System
2. Protocol
3. Authors

First must be logged into npm to install Phinx private packages:

npm login
Username: mdellano
Password: ********
Email: (this IS public) [email protected]

Then install:

npm install

The database engine used is PostgreSQL and we use @phinxlab/pg-manager library for connectivity. Edit /database_scripts/database-config.json to specify database connection settings.

We use @phinxlab/log-manager library for logging.

Declare globally in the export class you want to use it:

const LogManager = require('@phinxlab/log-manager'); 
const LOG = new LogManager('ModuleName');

Then you can use it:

LOG.error(err);

The protocol data returned:

{
  "data": [],
  "haserror": false,
  "metadata": {
    "page": 1,
    "total": 1,
    "rows": 1
  }
}

The protocol data returned in case of an error:

{
  "data": {
    "level": "error",
    "label": "QueryDAO",
    "timestamp": "2019-01-30T16:15:59.699Z"
  },
  "haserror": true,
  "metadata": {
    "message": "Failed to execute query. QueryDAO DAO => select c.*\n from person c\n where person_id = f"
  }
}

References:

| Field | Description | | ------------- | ------------- | | data | Requested data. In most cases it will be an array except findByPK requests, or null. | | data.level | (only in case of error) Error level: info, error. | | data.label | (only in case of error) Module where the error was throw. | | data.timestamp | (only in case of error) Error Date and time. | | haserror | [true/false] If there was an error during the execution. | | metadata.message | (only in case of error) Error message. | | metadata.page | The number of page returned for pagination. | | metadata.total | Total pages for pagination. | | metadata.rows | Total record count. |

• Phinx Software Lab. See the website.