Создавайте API с помощью Napa

 {
  "data": {
    "object_type": "contact",
    "id": "1",
    "name": "Devdatta Kane",
    "email": "[email protected]",
    "phone": "25451512544"
  }
}

Защита API

У нас есть полностью рабочий API. Ура! Но это совершенно небезопасно. БУ! Мы разрешаем доступ API без какой-либо аутентификации. Одним из наиболее простых используемых методов аутентификации для защиты API-интерфейсов является Token Authentication. Мы внедрим простую аутентификацию токена в нашем API, используя Devise . Мы могли бы также реализовать аутентификацию самостоятельно, но использование проверенной в битве библиотеки, такой как Devise, имеет свои преимущества.

Сначала добавьте Devise в наш Gemfile:

 gem 'devise'

И обновите комплект:

 bundle install

Devise теперь установлен, но нуждается в файле конфигурации. В Rails мы можем сгенерировать файл с помощью генератора Devise, но в Napa это не сработает. Поэтому мы вручную создадим файл в каталоге config / initializers . Создайте файл с именем devise.rb в этом каталоге и добавьте следующее:

 Devise.setup do |config|
  config.secret_key = '6e059f15248c9c26e7208a4a1129029c13f4a0fcef629562c34a4b3f0b1bbcbb8ed1431728cdbc6fe6e6bc4ed0f90cc9fc701c962e63be107e0bfd021eb70f08'
  config.mailer_sender = '[email protected]'
  require 'devise/orm/active_record'
  config.authentication_keys = [:email] 
  config.case_insensitive_keys = [:email ]
  config.strip_whitespace_keys = [:email ]
  config.skip_session_storage = [:http_auth]
  config.stretches = Rails.env.test? ? 1 : 10
  config.password_length = 8..128
end

Замените config.secret_key Теперь мы создадим модель User, используя генератор моделей Napa.

 napa generate model User

Напа создаст модельный класс и миграцию. Откройте класс миграции и добавьте следующее:

 ...
def change
  create_table :users do |t|
    t.string :email,              null: false, default: ""
    t.string :encrypted_password, null: false, default: ""
    t.string :authentication_token
    t.timestamps
  end
  add_index :users, :email, unique: true
  add_index :users, :authentication_token, :unique => true
end
...

Откройте app / models / user.rb и добавьте следующее:

 class User 

Теперь, когда у нас есть модель и миграция, перенесите базу данных:

 rake db:migrate

Мы создадим пользователя, используя консоль Napa, которую вы можете запустить:

 napa console

pry(main)> User.create!(email:'[email protected]', password:'abcdabcd', password_confirmation:'abcdabcd')

Вы должны получить следующий вывод:

 
=> #<user id: 1, email: "[email protected]", encrypted_password: "$2a$10$vdRAL.CusK3IEBTopa1cau5WTLihyNDdssuAtU3otieq...", authentication_token: "yFjgn5cwsFAfKhvU1R_t", created_at: "2015-08-08 11:41:05", updated_at: "2015-08-08 11:41:05">
</user>

Существует authentication_token Выходите из консоли.

Мы должны добавить поддержку аутентификации в наш API. Обновите app / apis / application_api.rb следующим образом:

 class ApplicationApi  '/contacts'

  add_swagger_documentation
end

Теперь снова запустите napa server

 curl -X GET http://localhost:9393/contacts

Это должно привести к ошибке, так как мы не передали токен доступа с запросом:

 {"error":{"code":"api_error","message":"401 Unauthorized"}}

Попробуйте тот же запрос, но с токеном доступа:

 curl -X GET http://localhost:9393/contacts\?access_token\=yFjgn5cwsFAfKhvU1R_t

И вы получите успешный ответ:

 {
  "data": {
    "object_type": "contact",
    "id": "1",
    "name": "Devdatta Kane",
    "email": "[email protected]",
    "phone": "25451512544"
  }
}

Заворачивать

Сегодня мы узнали, как быстро создавать API с помощью Napa. Napa предлагает дополнительную функциональность через промежуточное ПО, такое как ведение журнала и очистка конфиденциальных данных, которые вы можете изучить в репозитории Napa GitHub . Наше решение для аутентификации также может быть улучшено с помощью чего-то вроде OAuth и Access Grants, но я оставляю это упражнение для вас.

Комментарии и отзывы приветствуются, как всегда.