Routes - ovcharik/TravelFoot GitHub Wiki

REST - архитектура, которой желательно придерживаться при описании запросов.

Файл описания путей

В данном файле можно определить какой компонент системы будет обрабатывать тот или иной запрос пользователя.

Не смотря на простоту текущей реализации, я полагаю что нам должно этого хватить.

В json объекте описываются объекты именами для которых служат пути предполагаемого запроса. Эти пути описываются согласно формату определенному в Express.

Путь - это строка, которая стоит после домена[:порта] в строке запроса.

protocol://domain[:port][path][?[params]]

Например, для строки http://localhost:300/ путем будет являться /.

Для http://localhost:300/signup?user=test&password=password - путь /signup.

В каждом объекте пути должны содержаться следующие поля:

  • method - название метода по которому будет обрабатываться запрос
    • all - обработка всех запросов
    • get, post, put, delete, ... - конкретный тип запроса. Подробнее.
  • controller - название контроллера, который будет заниматься в обработкой запроса. Все контроллеры должны предварительно описаны здесь
  • action - имя метода в контроллере, которому передается управление

Если на один путь приходится несколько запросов, тогда можно поставить массив объектов к такому пути. Каждый объект в массиве должен быть описан аналогично сказанному выше. В файле routes.coffee путь /signup демонстрирует такую возможность.