From 34cfbfc08eb3f284a0057ade7f91c33a131283fa Mon Sep 17 00:00:00 2001 From: Alex Date: Mon, 13 Mar 2017 19:31:49 +0200 Subject: [PATCH] allposition docs --- app/library/App/Bootstrap/RouteBootstrap.php | 2 +- app/library/App/Controllers/AllPositionController.php | 14 ++++++++++---- app/library/App/Resources/AllPositionResource.php | 202 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++------------------ 3 files changed, 195 insertions(+), 23 deletions(-) diff --git a/app/library/App/Bootstrap/RouteBootstrap.php b/app/library/App/Bootstrap/RouteBootstrap.php index 33da3b8..32fe76a 100755 --- a/app/library/App/Bootstrap/RouteBootstrap.php +++ b/app/library/App/Bootstrap/RouteBootstrap.php @@ -38,7 +38,7 @@ class RouteBootstrap implements BootstrapInterface $view->setVar('title', $config->get("application")->title); $view->setVar('description', $config->get("application")->description); - $view->setVar('documentationPath', $config->get("hostName") . '/export/documentation.json'); + $view->setVar('documentationPath', $config->get("hostName") . ':8080/export/documentation.json'); return $view->render('general/documentation'); }); } diff --git a/app/library/App/Controllers/AllPositionController.php b/app/library/App/Controllers/AllPositionController.php index cb77ea4..d4defff 100644 --- a/app/library/App/Controllers/AllPositionController.php +++ b/app/library/App/Controllers/AllPositionController.php @@ -33,9 +33,12 @@ class AllPositionController extends CrudResourceController public function projectsAction() { + /** user params **/ + $id_group = $this->request->get('id_group') ?? null; + $APObj = new Client(self::API_KEY); - $projects_info = $APObj->getProjects(); + $projects_info = $APObj->getProjects($id_group); return $projects_info; @@ -55,10 +58,11 @@ class AllPositionController extends CrudResourceController /** user params **/ $project = $this->request->get('project') ?? 418068; + $id_group = $this->request->get('id_group') ?? null; $APObj = new Client(self::API_KEY); - $projects_info = $APObj->getQueries($project); + $projects_info = $APObj->getQueries($project, $id_group); return $projects_info; @@ -82,10 +86,11 @@ class AllPositionController extends CrudResourceController /** user params **/ $project = $this->request->get('project') ?? 418068; $date = $this->request->get('date') ?? '2017-01-31'; + $prev_date = $this->request->get('prev_date') ?? '2017-01-01'; $APObj = new Client(self::API_KEY); - $projects_info = $APObj->getReport($project, $date); + $projects_info = $APObj->getReport($project, $date, $prev_date); return $projects_info; @@ -97,10 +102,11 @@ class AllPositionController extends CrudResourceController $project = $this->request->get('project') ?? 418068; $get_start_date = $this->request->get('start') ?? '30daysAgo'; $get_end_date = $this->request->get('end') ?? 'today'; + $id_se = $this->request->get('id_se') ?? 0; $APObj = new Client(self::API_KEY); - $projects_info = $APObj->getVisibility($project, $get_start_date, $get_end_date); + $projects_info = $APObj->getVisibility($project, $get_start_date, $get_end_date, $id_se); return $projects_info; diff --git a/app/library/App/Resources/AllPositionResource.php b/app/library/App/Resources/AllPositionResource.php index 5759a26..ec8b81a 100644 --- a/app/library/App/Resources/AllPositionResource.php +++ b/app/library/App/Resources/AllPositionResource.php @@ -32,51 +32,217 @@ class AllPositionResource extends ApiResource ->endpoint( ApiEndpoint::factory('/project', HttpMethods::GET, 'projectAction') - ->name('project') - ->description('Данные о проекте') - ->allow(AclRoles::USER) + ->name('project') + ->description('Данные о проекте') + ->exampleRequest([ + 'required params' => [ + 'project' => "integer(ID проекта)" + ] + ]) + ->exampleResponse([ + "url" => "rukzachok.com.ua(URL проекта)", + "cy" => "60(тИЦ)", + "pr" => "0(Google PageRank)", + "yaca" => "0(Наличие сайта в Яндекс каталоге)", + "dmoz" => "0(Наличие сайта в DMOZ)", + "yahoo" => "0(Наличие сайта в Yahoo)", + "name" => "rukzachok.com.ua", + "interval" => 0 + ]) + ->allow(AclRoles::USER) ) ->endpoint( ApiEndpoint::factory('/projects', HttpMethods::GET, 'projectsAction') - ->name('projects') - ->description('Список проектов пользователя') - ->allow(AclRoles::UNAUTHORIZED) + ->name('projects') + ->description('Список проектов пользователя') + ->exampleRequest([ + 'required params' => [], + 'optional params' => [ + 'id_group' => "integer(ID проекта)" + ] + ]) + ->exampleResponse([ + [ + "id_project" => "{id}(ID проекта)", + "id_group" => "11111(ID группы проектов)", + "url" => "8nebo.com(URL проекта)", + "cy" => "20(тИЦ)", + "pr" => "0(Google PageRank)", + "name" => "8nebo.com", + "interval" => 7, + "sleep" => 1 + ], + [ + "id_project" => "{id}(ID проекта)", + "id_group" => "11111(ID группы проектов)", + "url" => "a-v-z.com.ua(URL проекта)", + "cy" => "10(тИЦ)", + "pr" => "0(Google PageRank)", + "name" => "", + "interval" => 0, + "sleep" => 0 + ] + ]) + ->allow(AclRoles::USER) ) ->endpoint( ApiEndpoint::factory('/projects_group', HttpMethods::GET, 'projectsGroupAction') - ->name('projects group') - ->description('Список групп проектов') - ->allow(AclRoles::USER) + ->name('projects group') + ->description('Список групп проектов') + ->exampleRequest([ + 'required params' => [] + ]) + ->exampleResponse([ + [ + "id_group" => "{id}(ID группы проектов)", + "group" => "bkko.com.ua(Название группы)" + ], + [ + "id_group" => "{id}(ID группы проектов)", + "group" => "Dveri(Название группы)" + ] + ]) + ->allow(AclRoles::USER) ) ->endpoint( ApiEndpoint::factory('/queries', HttpMethods::GET, 'queriesAction') - ->name('queries') - ->description('Список запросов, по которым определяется позиция сайта') - ->allow(AclRoles::USER) + ->name('queries') + ->description('Список запросов, по которым определяется позиция сайта') + ->exampleRequest([ + 'required params' => [ + 'project' => 'integer(ID проекта)' + ], + 'optional params' => [ + 'id_group' => 'integer(ID группы запросов)' + ] + ]) + ->exampleResponse([ + [ + "id_query" => "{id}(ID запроса)", + "id_group" => "{id}(ID группы запросов)", + "query" => "=рюкзаки переноски для детей(Запрос)", + "freq" => "50(Частота запроса)", + "url" => "(URL целевой страницы)" + ], + [ + "id_query" => "{id}(ID запроса)", + "id_group" => "{id}(ID группы запросов)", + "query" => "dakine кошелек(Запрос)", + "freq" => "10(Частота запроса)", + "url" => "(URL целевой страницы)" + ] + ]) + ->allow(AclRoles::USER) ) ->endpoint( ApiEndpoint::factory('/queries_group', HttpMethods::GET, 'queriesGroupAction') ->name('queries group') ->description('Список групп запросов') + ->exampleRequest([ + 'required params' => ['project' => 'integer(ID проекта)'] + ]) + ->exampleResponse([ + [ + "id_group" => "{id}(ID группы запросов)", + "group" => "head рюкзак(Название группы)" + ], + [ + "id_group" => "{id}(ID группы запросов)", + "group" => "quiksilver рюкзак(Название группы)" + ] + ]) ->allow(AclRoles::USER) ) ->endpoint( ApiEndpoint::factory('/report', HttpMethods::GET, 'reportAction') - ->name('report') - ->description('Отчет по позициям сайта') - ->allow(AclRoles::USER) + ->name('report') + ->description('Отчет по позициям сайта') + ->exampleRequest([ + 'required params' => [ + 'project' => 'integer(ID проекта)' + ], + 'optional params' => [ + 'date' => 'date(дата отчета в формате Y-m-d (например, 2010-12-31))', + 'prev_date' => 'date(дата для сравнения позиции сайта в формате Y-m-d (например, 2010-12-30))' + ] + ]) + ->exampleResponse([ + "count" => "526(Количество запросов)", + "top3" => "50(Запросов в ТОП 3)", + "top10" => "113(Запросов в ТОП 3)", + "top30" => "275(Запросов в ТОП 3)", + "down" => "230(Позиций улучшилось)", + "up" => "205(Позиций улучшилось)", + "sengines" => [ + [ + "id_se" => "{id}(ID поисковой системы)", + "name_se" => "Google(название поисковой системы)", + "name_region" => "com.ua/Киев(название региона)" + ], + [ + "id_se" => "{id}(ID поисковой системы)", + "name_se" => "Google(название поисковой системы)", + "name_region" => "com.ua(название региона)" + ] + ], + "queries" => [ + [ + "id_query" => "{id}(ID запроса)", + "query" => "=рюкзаки переноски для детей(запрос)", + "wordstat" => "50(частота запроса)" + ], + [ + "id_query" => "{id}(ID запроса)", + "query" => "dakine кошелек(запрос)", + "wordstat" => "10(частота запроса)" + ] + ], + "positions" => [ + [ + "position " => "{id}(ID запроса)", + "prev_position " => "=рюкзаки переноски для детей(запрос)", + "change_position" => "50(частота запроса)", + "url" => "50(частота запроса)" + ], + [ + "position " => "(текущая позиция сайта)", + "prev_position " => "(предыдущая позиция сайта)", + "change_position" => "(изменение позиции сайта)", + "url" => "(найденный URL)" + ] + ] + ]) + ->allow(AclRoles::USER) ) ->endpoint( ApiEndpoint::factory('/visibility', HttpMethods::GET, 'visibilityAction') - ->name('visibility') - ->description('Данные о видимости сайта за указанный период') - ->allow(AclRoles::USER) + ->name('visibility') + ->description('Данные о видимости сайта за указанный период') + ->exampleRequest([ + 'required params' => [ + 'project' => 'integer(ID проекта)' + ], + 'optional params' => [ + 'start' => 'date(начальная дата в формате Y-m-d (например, 2010-12-01))', + 'end' => 'date(конечная дата в формате Y-m-d (например, 2010-12-31))', + 'id_se' => 'integer(ID поисковой системы)' + ] + ]) + ->exampleResponse([ + "2017-02-13" => "0.2", + "2017-02-15" => "0.2", + "2017-02-20" => "0.3", + "2017-02-26" => "0.3", + "2017-03-06" => "0.3", + "2017-03-12" => "0.2" + ]) + ->allow(AclRoles::USER) ) ; -- libgit2 0.21.4