Default config

Add changes in exposerjs/config.yml

This is the default configuration, if there are changes it can be added in exposerjs/config.yml

prefix: "/api"
port: 3001
verbs:
  get:
    findUnique: "/:id"
    findMany: ""
    findFirst: "/first"
    count: "/count"
    aggregate: "/aggregate"
    groupBy: "/groupBy"
  post:
    create: ""
  put:
    upsert: ""
  patch:
    update: "/:id"
    updateMany: "/update"
  delete:
    delete: "/:id"
    deleteMany: ""
tokenVerify: true
tokenKey: "EXPOSER_TOKEN_KEY"
aclVerify: true
aclType: "fast"
autoImport: false
userModel:
  roleId: "roleId"
  defaultRoleId: 1
roleModel:
  tableName: "role"
  id: "id"
  name: "name"
aclModel:
  tableName: "acls"
  model: "model"
  name: "name"
  allow: "allow"

Deprecated apart from version 0.2.6

WARNING

/* More code */
const myConfig = { prefix: "/api" };
exposer.run({
  PrismaClient, 
  config: myConfig
});

Properties explained

Prefix

Add prefix in your methods

/[prefix]/[model]/[methodName] → /api/users/addUser

Verbs

Add methods http with Prisma model queries

Request:

GET /api/users/1

Executed:

return prisma.user.findUnique({
  where: {
    id: 1,
  },
});

TokenVerify (Enable by default)

Choose whether you want token validation enabled before executing each method.

JsonWebToken

For token management we use JsonWebToken internally

TokenKey

TokenKey

We recommend changing the key

Choose your token key with which tokens are generated for users.

AclVerify & AclType

Choose whether you want acl validation enabled before executing each method.

AclTypes

View more in Acls Section

[table]Model

If you use a different table structure you can indicate it here.

Example

If your acl's table is this:

model userrestriction {
  id          Int      @id @default(autoincrement())
  rolefk      Int
  section     String   @db.VarChar(25)
  route       String?  @db.VarChar(25)
}

You pass this in configuration:

exposer.run({
  PrismaClient,
  aclModel: {
    tableName: "userrestriction",
    model: "section",
    name: "route",
    allow: "rolefk",
  },
});

AutoImport

If you use a directory (or several) to store the methods you can activate auto import

Example

exposer.run({
  PrismaClient, 
  config: {
    autoImport: {
      paths: './src/routes' // ← String or Array ['src/routes', 'src/otherRoutes', ...] *Required
      getFile: (n) => n.includes('.js') // ← Default function
    }
  }
});

Example

If you have, for example, the directory:

• /src
  • /routes
    • /myFirstModel
      • myFistMethod.js
      • mySecretFile.js

You can add this in config:

exposer.run({
  PrismaClient, 
  config: {
    autoImport: {
      paths: './src/routes/myFirstModel' // OR './src/routes' if you want
    }
  }
});

You can use the "getFile" parameter to include or exclude specific files

exposer.run({
  PrismaClient, 
  config: {
    autoImport: {
      paths: './src/routes/myFirstModel' // OR './src/routes' if you want
      getFile: (fileName) => fileName != 'mySecretFile.js'
    }
  }
});