XMS API CORE
XMS2 API CORE documentation
Setup
Install the module
yarn add @ax2/xms-api-core
Necessary Env variables
Option | Description |
---|---|
NODE_ENV |
local , prod or dev
|
LANG_FALLBACK |
default lang to use (default ='en') |
LANG_KEYS |
multilang keys (example 'fr,en') |
MEDIA_DIRECTORY |
Directory on gcp to upload media |
GCP_PROJECT_ID |
Project ID from gcp |
GCP_CREDENTIALS_PATH |
Path for gcp credentials (necessary for non gcp micro-services) |
STORAGE_BUCKET |
Name of the bucket to upload on gcp storage |
MEDIA_RESIZING |
Set to 1 to resize media on upload |
MYSQL_DB_NAME |
MySQL database name |
MYSQL_DB_USER |
MySQL user |
MYSQL_DB_PASSWORD |
MySQL password |
MYSQL_DB_HOST |
MySQL host (default: 127.0.0.1) |
MYSQL_DB_PORT |
Mysql Port (default: 3306) |
REDIS_HOST |
Redis Host (default: 127.0.0.1) |
REDIS_PORT |
Redis Port (default: 6379) |
REDIS_PASSWORD |
Redis Password (default: '') |
REDIS_PREFIX |
Redis prefix for cache key (default: '') |
REDIS_ENABLE |
Set to 1 to enable Redis (default: disabled) |
REDIS_ENABLE |
Set to 1 to enable Redis (default: disabled) |
SENTRY |
Sentry DSN |
Load the module into the core
import * as CORE from '@ax2/xms-api-core';
class Article extends CORE.Citadelle implements CORE.ModelItem {}
import { Citadelle, ModelItem } from '@ax2/xms-api-core';
class Article extends Citadelle implements ModelItem {}
Available class
// Models function
import { Citadelle, ModelItem, ModelError, } from '@ax2/xms-api-core';
// Helpers function
import { FunctionKit, StorageAPI, DateKit, Utils, MigrationQuery, MigrateHelper, Sentry, Response, Message } from '@ax2/xms-api-core';
// Services function
import { FileService, FilterService } from '@ax2/xms-api-core';