namespacing

You can also use namespacing to reflect folder and uri structures at once. The following example would require the respective users controller to be located at app/controllers/Api/V1/UsersController.ts

import { PsychicRouter } from 'psychic'

export default (r: PsychicRouter) => {
  r.namespace('api', (r) => {
    r.namespace('v1', (r) => {
      r.namespace('users', (r) => {
        r.get('hi')
      })
    })
  })
}

GET api/v1/users/hi Api/V1/Users#hi

Namespacing will always enforce the folder structure when presented with multiple route segments, which means you are required to put controllers in the expected folder structure in order for an action to be called when its corresponding route is hit. This can, of course, be overridden by passing an explicit controller to the namespace call.

r.namespace('api', (r) => {
  r.namespace('v1', (r) => {
    // providing an explicit controller to the namespace
    r.namespace('users', { controller: HelloWorldController } (r) => {
      r.get('hi')
    })
  })
})

GET api/v1/users/hi HelloWorld#hi

Additionally, controller overrides can be passed to the child routes

r.namespace('api', (r) => {
  r.namespace('v1', (r) => {
    r.namespace('users', (r) => {
      // providing an explicit controller to the
      // individual child route of a namespace
      r.get('hi', HelloWorldController, 'hi')
    })
  })
})

GET api/v1/users/hi HelloWorld#hi

scope

In addition to namespace, Psychic also provides the scope method, which behaves identically to namespace, except that it does not enforce that particular segment within the path of the controller. In the following example, the UsersController will be expected to be located at app/controllers/UsersController.ts.

r.scope('api', (r) => {
  r.scope('v1', (r) => {
    r.scope('users', (r) => {
      r.get('hi')
    })
  })
})

GET api/v1/users/hi Users#hi