Skip to main content

CMSRouteConfig

This is an internal route-config array (DefaultRouteConfig[]) that maps the CMSController methods to specific URL endpoints on your Archibald server.

Available Routes​

  • ${base}/${version}/cms/pages -> maps to CMSController.getPage
  • ${base}/${version}/cms/preview/{previewTicketId} -> maps to CMSController.getPreviewContext

Usage​

This is an internal framework component. You do not need to interact with it directly.

Deep Dive​

Description: The CMSRouteConfig array is responsible for wiring up the server's routing layer. When the CMSModule is registered, it uses this configuration to tell the underlying web server (Hapi) which controller methods should be executed for which incoming URL patterns.

  • How To: As an internal component, you don't interact with it directly. Its existence is what makes the API endpoints available to your client-side CMSAdapter. Your adapter's getPage method, for example, knows to make a request to /api/cms/pages because that's the route defined by this configuration.

  • Best Practice: This configuration establishes the API contract between the Archibald client and server for CMS functionality. It's important not to change these routes. If you were to create a custom server setup and change these paths, the standard CMSAdapter on the client would no longer be able to communicate with the server. If custom CMS-related routes are needed, they should be created as part of a new, custom module, leaving the default CMSRouteConfig intact.