api_scaffolding

API Scaffolding

Генерация контроллеров API и модулей с параметрами Grape и Grape Entity.

Установка

Добавить в Gemfile

group :development do
  gem 'api_scaffolding'
end

И выполнить:

bundle

Конфигурация

Для создания файла конфигурации выполнить:

rails g api_scaffold:install

И отредактировать созданный файл config/initializers/api_scaffold.rb

Использование

Сгенерировать класс контроллера API, модуль с параметрами и файл сериалайзера:

rails g api_scaffold Model

Опции:

--api_version - версия API, по умолчанию отсутствует

--no_params - не создавать модуль с параметрами, по умолчанию - создается

--no_entity - не создавать класс с Grape Entity, по умолчанию - создается

Сгенерировать класс контроллера API отдельно:

rails g api_scaffold:controller Model

Опции:

--api_version - версия API, по умолчанию отсутствует

--no_params - не указывать в контроллере модуль с параметрами, по умолчанию - указывается

--no_entity - не указывать в контроллере класс с Grape Entity, по умолчанию - указывается

Сгенерировать модуль с параметрами отдельно:

rails g api_scaffold:params_concern Model

Опции:

--api_version - версия API, по умолчанию отсутствует

Сгенерировать Grape Entity отдельно:

rails g api_scaffold:entity Model

Опции:

--api_version - версия API, по умолчанию отсутствует

Примечания

• При добавлении описаний методов API и параметров используются описания таблиц и их колонок в БД.