Demo MongoDB Backend

A mongodb backend connector with rest-api and some added functionality, for demo purposes only.

How to use

# Create the image
docker-compose build demobackend

# Run a full set including pool, api, schemacompiler, mongodb, demobackend
# Demobackend reachable at localhost:8011 or 172.16.0.110:8011
docker-compose -f docker-compose.all.yaml up

# Or: Run only demobackend and mongodb at localhost
docker-compose up

Authentication is provided by the API. Register and login there. The provided token can be used for the demobackend. IDC_API_JWT_SECRET must be the same for both api and demobackend.

Configuration

Use .env (or environment variables), valid attributes are:

DEMO_BACKEND_HOST
# default: 8011
DEMO_BACKEND_PORT

# should be the same as for the api
IDC_API_JWT_SECRET

# default: debug
DEMO_BACKEND_LOG_LEVEL

# default: mongodb
IDC_API_DB_HOST
# default: 27017
IDC_API_DB_PORT
IDC_API_DB_USER
IDC_API_DB_PASSWORD

Collections

• See routes.js for enabled collections.

Paths

Path	Methods
/models	GET
/models/:role	GET
/:collection	GET, POST
/:collection/:id	GET, PUT, DELETE

NOTE: GET /models returns registered collections and their schemas. GET /models/:role returns collections and their schemas for a specific role.

NOTE: GET /:collection also supports query parameters (exact match) for every field in the model, e.g. GET /citizens?familyName=Digital

Model

• See models/*.js for structures

How to add models

1. Create new model in models/. Structurally, the schema should define types for fields as e.g. fieldName: { type: String } and not fieldName: String to correctly generate documentation for the /models and /models/:role endpoints.

  // THIS IS FALSE
  const schema = new Mongoose.Schema(
    {
      fieldName: String
    }
  )

  // THIS IS BETTER
  const schema = new Mongoose.Schema(
    {
      fieldName: {
        type: String
      }
    }
  )

2. Models should export both the model and schema object.

  const model = Mongoose.model('ModelName', schema)

  module.exports = { schema, model }