For AI agents: the complete documentation index is available at https://docs.dataplatform.ovh.net/llms.txt, the full documentation bundle is available at https://docs.dataplatform.ovh.net/llms-full.txt, and this page is available as Markdown at https://docs.dataplatform.ovh.net/sdk/api-configure-module.md.
  • 🇬🇧 English

    • Manage modules

    Warning

    Rework pending, no delivery date. The Front App SDK (ReactJS) and the Front API SDK (NodeJS) are both being replaced. This page documents the current release, remains accurate, and is maintained until the replacement ships. Code written against it keeps working.

    APIs work primarily with modules that can be interconnected. Those modules are configured in the forepaas.json file at the root of your Front API, along with the rest of the API configuration:

    //forepaas.json
{
  "id": "frontapi", // unique ID: used if you choose to publish  as a "template" in the store
  "type": "api", // forepaas.json is used for 'app' and 'api', here it is 'api'
  "language": "node", // Language used for the API
  "name": "FrontAPI",
  "version": "0.0.1",
  "modules": {...}, // Detailed below in the "Configure modules" section
  "dependencies": {...} //

    This file is fully configurable via the OVHcloud Data Platform, on the Extension configuration of your API. The file forepaas.json is automatically modified each time you install or uninstall a module from the platform.

    The modules' configuration is done via two separate fields:

    • the modules key: it contains the list of modules to be installed
    • the dependencies key

    Configure modules

    Here is an example of a configuration :

      "modules": {
    "sdk": {
      "version": "2.4.0"
    },
    "iam": {
      "version": "1.0.0"
    },
    "cache-redis": {
      "version": "2.0.0"
    },
    "qb": {
      "version": "2.4.0",
      "dependencies": {
        "authentication": {
          "module": "iam"
        },
        "cache": {
          "module": "cache-redis"
        }
      }
    }
  }

    For a better understanding, here is a short description of each module:

    • sdk: the heart of the Front API. It is essential, but replaceable if you want to modify the standard behavior of OVHcloud Data Platform APIs
    • iam: a connector to the Project's Identity Access Manager. It allows you to manage access to your API.
    • cache-redis: a cache connector to a Redis database
    • qb: a connector to the Analytics Manager, to query and use your data in your applications

    All modules act independently. However, qb module relies upon cache and authentication. In this sample, it is configured to use iam module to manage authentication and cache-redis for cache.

    Warning

    ⚠️ Without the iam module, your API does not have any access control!

    Go further

    If you need training or technical assistance to implement our solutions, contact your sales representative or click on this link to get a quote and ask our Professional Services experts for a custom analysis of your project.

    Ask questions, give your feedback and interact directly with the team building the Data Platform on the dedicated Discord channel.

    If you need support with your OVHcloud services, create a request in our Help Centre.

    Join our community of users.