Сборка отличного аписа с виноградом

Внутри emp_api / app / api создайте еще одну папку с именем employee и файл в этом каталоге с именем data.rb. Этот файл содержит класс для доступа к модели Employee.

Внутри emp_api / app / api / создайте еще один файл с именем api.rb, где мы смонтируем класс, определенный в emp_api / app / api / employee / data.rb.

Согласно инструкциям на страницах Grape GitHub , поскольку мы разместили наш код API в app / app , этот каталог необходимо добавить в пути загрузки / автозагрузки. Установите его в config / application.rb, как показано ниже:

 require File.expand_path('../boot', __FILE__)

require 'rails/all'

Bundler.require(*Rails.groups)

module EmpApi
  class Application < Rails::Application
    ## Newly Added code to set up the api code
    config.paths.add File.join('app', 'api'), glob: File.join('**', '*.rb')
    config.autoload_paths += Dir[Rails.root.join('app', 'api', '*')]
  end
end

Создание API

Grape API — это Rack-приложения, созданные путем создания подкласса Grape::API Давайте начнем с создания первой конечной точки API для извлечения всех данных о сотрудниках. Откройте app / api / employee / data.rb и создайте класс модуля, как показано ниже:

 module Employee
  class Data < Grape::API

    resource :employee_data do
      desc "List all Employee"

      get do
        EmpData.all
      end

    end

  end
end

Нам нужно получить доступ к функциональности класса Employee::Data Итак, мы будем использовать mountEmployee::DataAPI

Итак, откройте app / api / api.rb и смонтируйте Employee::Data

 class API < Grape::API
  prefix 'api'
  version 'v1', using: :path
  mount Employee::Data
end

Откройте app / config / rout.rb и включите следующий код для маршрутизации вызовов API на наш корневой адрес:

 Rails.application.routes.draw do
  mount API => '/'
end

Запустите сервер рельсов:

 rails server

Откройте новый терминал и попробуйте:

 curl http://localhost:3000/api/v1/employee_data.json

Вы увидите [] У нас нет способа добавить сотрудников, так что давайте исправим это.

Добавьте другую конечную точку API для создания нового сотрудника. Для создания сотрудника нам понадобятся определенные значения, такие как имя, адрес и возраст. Grape позволяет нам определять, являются ли эти параметры обязательными или необязательными в самом API.

Откройте app / api / employee / data.rb и добавьте следующий код, чтобы создать конечную точку API для создания сотрудников.

 desc "create a new employee"
## This takes care of parameter validation
params do
  requires :name, type: String
  requires :address, type:String
  requires :age, type:Integer
end
## This takes care of creating employee
post do
  EmpData.create!({
    name:params[:name],
    address:params[:address],
    age:params[:age]
  })
end

Перезапустите сервер и используйте curl

 curl http://localhost:3000/api/v1/employee_data.json -d "name=jay;address=delhi;age=25"

Теперь у нас должен быть сотрудник:

 curl http://localhost:3000/api/v1/employee_data.json

[{"id":1,"name":"jay","address":"delhi","age":25,"created_at":"2014-10-27T16:43:49.303Z","updated_at":"2014-10-27T16:43:49.303Z"}]

Бинго.

API удаления и обновления для модели сотрудника выполняется по аналогии с нашими конечными точками чтения и создания.
Для удаления конечной точки требуется идентификатор сотрудника:

 # app/api/employee/data.rb

 desc "delete an employee"
 params do
   requires :id, type: String
 end
 delete ':id' do
   EmpData.find(params[:id]).destroy!
 end

Перезапустите сервер Rails и протестируйте API, удалив сотрудника, которого мы создали ранее.

 curl -X DELETE http://localhost:3000/api/v1/employee_data/1.json

{"id":1,"name":"jay","address":"delhi","age":25,"created_at":"2014-10-27T16:43:49.303Z","updated_at":"2014-10-27T16:43:49.303Z"}

Теперь, если вы проверяете список сотрудников API, вы должны получить пустой ответ.

Далее, чтобы обновить данные сотрудника, нам нужно будет передать идентификатор сотрудника и значения, которые будут обновлены. Добавьте следующий код, чтобы создать конечную точку API для обновления адреса сотрудника:

 # app/api/employee/data.rb

desc "update an employee address"
params do
  requires :id, type: String
  requires :address, type:String
end
put ':id' do
  EmpData.find(params[:id]).update({
    address:params[:address]
  })
end

Но у нас нет сотрудника для обновления. Помните, что мы удалили последнего сотрудника, поэтому нам нужно добавить его обратно, чтобы обновить его.

Перезагрузите сервер и сначала добавьте нового сотрудника,

 curl http://localhost:3000/api/v1/employee_data.json -d "name=roy;address=kerala;age=25"

{"id":2,"name":"roy","address":"kerala","age":25,"created_at":"2014-10-27T16:59:54.090Z","updated_at":"2014-10-27T16:59:54.090Z"}

Теперь используйте следующую команду для обновления адреса нового сотрудника:

 curl -X PUT http://localhost:3000/api/v1/employee_data/2.json -d "address=mumbai"

true

Завершение

В этом уроке мы начали создавать простой CRUD API с использованием инфраструктуры Grape. Подробная документация относительно винограда доступна на их страницах GitHub .

Код из этого урока доступен на GitHub .