Каков правильный способ добавления контроллера API?

Question

Я пытаюсь добавить конечную точку API в мое приложение Rails (версия 5.0.1), основанное на Getting Started guide, но когда я пытаюсь создать контроллер, он заканчивает создание erbs и другого cruft. Я подозреваю, t требуется для контроллера только для API.

Какова правильная команда для выдачи?

Я попытался использовать rails generate controller api index show new edit create update destroy с опцией --api.

Я бы приветствовал ссылки на хорошие путеводители, чтобы следовать; это мой первый проект Rails, и я нашел только полезные руководства для создания приложения только для API или веб-приложения, а не для добавления конечных точек API в существующее приложение.

Answer 1

Существует много способов сделать это. Я бы предложил посмотреть API versioning, прежде чем начинать писать контроллер только для API. В любом случае общим стандартом для контроллеров API является использование соответствующего интервала между именами. Поэтому, если ваш контроллер должен называться StatsController, иерархия должна быть app/controllers/api/v1/stats_controller.rb. Используйте v2, v3 и т. Д. Для получения дополнительных версий вашего api. Идет, не сказав, что ваш StatsController должен теперь выглядеть так:

module Api 
    module V1 
    class StatsController < ApplicationController 
     . 
     . 
    end 
    end 
end