Class: CPApiRequestPagesList

Inherits:
CPApiRequestBase show all
Defined in:
lib/crowi/client/apireq/api_request_pages.rb

Overview

ページ一覧リクエスト用クラス

Constant Summary

Constants inherited from CPApiRequestBase

CPApiRequestBase::METHOD_GET, CPApiRequestBase::METHOD_POST

Instance Attribute Summary

Attributes inherited from CPApiRequestBase

#entry_point, #method, #param

Instance Method Summary collapse

Methods inherited from CPApiRequestBase

#invalid?, #valid?, #validation_msg

Constructor Details

#initialize(param = {}) ⇒ CPApiRequestPagesList

コンストラクタ

Parameters:

  • param (Hash) (defaults to: {}) —

    APIリクエストのパラメータ



11
12
13
14
 
# File 'lib/crowi/client/apireq/api_request_pages.rb', line 11

def initialize(param = {})
  super('/_api/pages.list', METHOD_GET,
        { path: param[:path_exp], user: param[:user] })
end

Instance Method Details

#execute(entry_point, rest_client_param: {}) ⇒ Array

リクエストを実行する

Parameters:

  • entry_point (String) —

    APIのエントリーポイントとなるURL（ex. localhost:3000/_api/pages.list）

  • rest_client_param (Hash) (defaults to: {}) —

    RestClientのパラメータ

Returns:

  • (Array) —

    リクエスト実行結果



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/crowi/client/apireq/api_request_pages.rb', line 21

def execute(entry_point, rest_client_param: {})

  if invalid?
    return validation_msg
  end

  params = { method: :get, url: entry_point, headers: { params: @param } }.merge(rest_client_param)
  ret = JSON.parse RestClient::Request.execute params
  if (ret['ok'] == false)
    return CPInvalidRequest.new "API return false with msg: #{ret['msg']}"
  end
  pages = []
  ret['pages'].each do |page|
    pages.push(CrowiPage.new(page))
  end
  return CPApiReturn.new(ok: ret['ok'], data: pages)
end