Geek Answers Handbook

APIPIE for a simple Rails application

I have a rails application (not rails-api)

class ApplicationController < ActionController::Base

but not

class ApplicationController < ActionController::API

I want HTML documentation for this application. I use apipie for this purpose, but I get

Oops!! Method <code></code> not found for resource <code></code>

The controllers are located in the application / controllers /, and the configuration seems fine to me.

I assume that the rails application can also be considered as an API. Controllers handle json if this is enough to consider an application as a web application or an API? Do I need to write a separate rails-api application for API purposes? Help me figure out the difference between the two in case I missed a point.

+4
source share
1

- API. . render : json API html -. . , , /.

:

Oops!!

/config/initializers/apipie.rb

Apipie.configure do |config|
  config.app_name                = "AppDepot"
  # set api base url here
  config.api_base_url            = "/api/v1"
  # set url here for open docs related to apidoc
  config.doc_base_url            = "/apidocs"
  # set true/false for default validation
  config.validate                = false
  # set copyright here
  config.copyright               = "&copy; 2014 sachin"
  config.validate_value          = false

  # where is your API defined?
  config.api_controllers_matcher = "#{Rails.root}/app/controllers/api/v1/*.rb"
  config.default_version = "1.0"
  config.app_info = "Tell about your application"

  # set username and password for access api
  config.authenticate = Proc.new do
    authenticate_or_request_with_http_basic do |username, password|
      username == "admin@example.com" && password == "password"
    end
  end
end

-, .

+1

More articles: