requests
This commit is contained in:
@ -9,6 +9,36 @@ use yii\filters\ContentNegotiator;
|
||||
use yii\rest\Controller;
|
||||
use yii\web\Response;
|
||||
|
||||
|
||||
/**
|
||||
* @OA\Info(
|
||||
* version="1.0.0",
|
||||
* title="Документация Гильдия",
|
||||
* description="Документация для работы с API",
|
||||
*
|
||||
* ),
|
||||
* @OA\PathItem(
|
||||
* path="/api"
|
||||
* ),
|
||||
* @OA\Server(
|
||||
* url="https://itguild.info/api",
|
||||
* description="Основной сервер",
|
||||
* ),
|
||||
*
|
||||
* @OA\Server(
|
||||
* url="https://guild.loc/api",
|
||||
* description="Локальный сервер",
|
||||
* ),
|
||||
*
|
||||
* @OA\SecurityScheme(
|
||||
* securityScheme="bearerAuth",
|
||||
* in="header",
|
||||
* name="Authorization",
|
||||
* type="http",
|
||||
* scheme="bearer",
|
||||
* bearerFormat="JWT",
|
||||
* ),
|
||||
*/
|
||||
class ApiController extends Controller
|
||||
{
|
||||
|
||||
|
||||
226
frontend/modules/api/controllers/RequestController.php
Normal file
226
frontend/modules/api/controllers/RequestController.php
Normal file
@ -0,0 +1,226 @@
|
||||
<?php
|
||||
|
||||
namespace frontend\modules\api\controllers;
|
||||
|
||||
use common\classes\Debug;
|
||||
use common\models\Request;
|
||||
use common\services\RequestService;
|
||||
use yii\web\BadRequestHttpException;
|
||||
use yii\web\NotFoundHttpException;
|
||||
|
||||
|
||||
class RequestController extends ApiController
|
||||
{
|
||||
|
||||
public function verbs(): array
|
||||
{
|
||||
return [
|
||||
'get-request' => ['get'],
|
||||
'get-request-list' => ['get'],
|
||||
'create-request' => ['post'],
|
||||
// 'update-task' => ['put', 'patch'],
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* @OA\Get(path="/request/get-request",
|
||||
* summary="Получить запрос",
|
||||
* description="Получения запроса по идентификатору",
|
||||
* security={
|
||||
* {"bearerAuth": {}}
|
||||
* },
|
||||
* tags={"Requests"},
|
||||
* @OA\Parameter(
|
||||
* name="request_id",
|
||||
* in="query",
|
||||
* required=true,
|
||||
* @OA\Schema(
|
||||
* type="integer",
|
||||
* )
|
||||
* ),
|
||||
* @OA\Parameter(
|
||||
* name="search_depth",
|
||||
* in="query",
|
||||
* required=false,
|
||||
* @OA\Schema(
|
||||
* type="integer",
|
||||
* default=3
|
||||
* )
|
||||
* ),
|
||||
* @OA\Response(
|
||||
* response=200,
|
||||
* description="Возвращает объект Запроса",
|
||||
* @OA\MediaType(
|
||||
* mediaType="application/json",
|
||||
* @OA\Schema(ref="#/components/schemas/Request"),
|
||||
* ),
|
||||
*
|
||||
* ),
|
||||
* )
|
||||
*/
|
||||
public function actionGetRequest(int $request_id, int $search_depth = 3): Request
|
||||
{
|
||||
if (empty($request_id) or !is_numeric($request_id)) {
|
||||
throw new NotFoundHttpException('Incorrect request ID');
|
||||
}
|
||||
|
||||
$request = RequestService::run($request_id)->getById();
|
||||
|
||||
if (empty($request)) {
|
||||
throw new NotFoundHttpException('The request does not exist');
|
||||
}
|
||||
|
||||
$request->result_count = RequestService::run($request_id)->count()->search($search_depth);
|
||||
|
||||
return $request;
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @OA\Get(path="/request/get-request-list",
|
||||
* summary="Создать запрос",
|
||||
* description="Метод для создания запроса, если параметр user_id не передан, то запрос создается от имени текущего пользователя.",
|
||||
* security={
|
||||
* {"bearerAuth": {}}
|
||||
* },
|
||||
* tags={"Requests"},
|
||||
* @OA\Parameter(
|
||||
* name="user_id",
|
||||
* in="query",
|
||||
* required=false,
|
||||
* @OA\Schema(
|
||||
* type="integer",
|
||||
* default=null
|
||||
* )
|
||||
* ),
|
||||
* @OA\Parameter(
|
||||
* name="search_depth",
|
||||
* in="query",
|
||||
* required=false,
|
||||
* @OA\Schema(
|
||||
* type="integer",
|
||||
* default=3
|
||||
* )
|
||||
* ),
|
||||
* @OA\Response(
|
||||
* response=200,
|
||||
* description="Возвращает объект Запроса",
|
||||
* @OA\MediaType(
|
||||
* mediaType="application/json",
|
||||
* @OA\Schema(ref="#/components/schemas/RequestsExample"),
|
||||
* ),
|
||||
* ),
|
||||
* )
|
||||
*
|
||||
* @param int|null $user_id
|
||||
* @return array|\yii\db\ActiveRecord[]
|
||||
*/
|
||||
public function actionGetList(int $user_id = null, int $search_depth = 3): array
|
||||
{
|
||||
if (!$user_id) {
|
||||
$user_id = \Yii::$app->user->id;
|
||||
}
|
||||
|
||||
$requests = RequestService::run()->getByUserId($user_id);
|
||||
|
||||
foreach ($requests as $request) {
|
||||
$request->result_count = RequestService::run($request->id)->count()->search($search_depth);
|
||||
}
|
||||
|
||||
return $requests;
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @OA\Post(path="/request/create-request",
|
||||
* summary="Получить список запросов",
|
||||
* description="Метод для оздания запроса, если не передан параметр <b>user_id</b>, то будет получен список текущего пользователя",
|
||||
* security={
|
||||
* {"bearerAuth": {}}
|
||||
* },
|
||||
* tags={"Requests"},
|
||||
*
|
||||
* @OA\RequestBody(
|
||||
* @OA\MediaType(
|
||||
* mediaType="multipart/form-data",
|
||||
* @OA\Schema(
|
||||
* required={"position_id", "title", "status"},
|
||||
* @OA\Property(
|
||||
* property="user_id",
|
||||
* type="integer",
|
||||
* description="Идентификатор пользователя",
|
||||
* ),
|
||||
* @OA\Property(
|
||||
* property="title",
|
||||
* type="string",
|
||||
* description="Заголовок запроса",
|
||||
* ),
|
||||
* @OA\Property(
|
||||
* property="position_id",
|
||||
* type="integer",
|
||||
* description="Позиция",
|
||||
* ),
|
||||
* @OA\Property(
|
||||
* property="knowledge_level_id",
|
||||
* type="integer",
|
||||
* description="Уровень",
|
||||
* ),
|
||||
* @OA\Property(
|
||||
* property="specialist_count",
|
||||
* type="integer",
|
||||
* description="Количество специалистов",
|
||||
* ),
|
||||
* @OA\Property(
|
||||
* property="status",
|
||||
* type="integer",
|
||||
* description="Статус запроса",
|
||||
* ),
|
||||
* @OA\Property(
|
||||
* property="descr",
|
||||
* type=" string",
|
||||
* description="Описание запроса",
|
||||
* ),
|
||||
* @OA\Property(
|
||||
* property="skill_ids",
|
||||
* type="array",
|
||||
* description="Навыки",
|
||||
* @OA\Items(
|
||||
* type="integer",
|
||||
* ),
|
||||
* ),
|
||||
* ),
|
||||
* ),
|
||||
* ),
|
||||
* @OA\Response(
|
||||
* response=200,
|
||||
* description="Возвращает объект Запроса",
|
||||
* @OA\MediaType(
|
||||
* mediaType="application/json",
|
||||
* @OA\Schema(ref="#/components/schemas/Request"),
|
||||
* ),
|
||||
* ),
|
||||
* )
|
||||
*
|
||||
* @return Request
|
||||
* @throws BadRequestHttpException
|
||||
*/
|
||||
public function actionCreateRequest()
|
||||
{
|
||||
$user_id = \Yii::$app->user->id;
|
||||
if (!$user_id){
|
||||
throw new BadRequestHttpException(json_encode(['Пользователь не найден']));
|
||||
}
|
||||
|
||||
$requestService = RequestService::run()
|
||||
->setUserId($user_id)
|
||||
->load(\Yii::$app->request->post(), '')
|
||||
->save();
|
||||
|
||||
if (!$requestService->isSave){
|
||||
throw new BadRequestHttpException(json_encode($requestService->errors));
|
||||
}
|
||||
|
||||
return $requestService->getModel();
|
||||
}
|
||||
|
||||
}
|
||||
25
frontend/modules/api/models/Position.php
Normal file
25
frontend/modules/api/models/Position.php
Normal file
@ -0,0 +1,25 @@
|
||||
<?php
|
||||
|
||||
namespace frontend\modules\api\models;
|
||||
|
||||
/**
|
||||
* @OA\Schema(
|
||||
* schema="Position",
|
||||
* @OA\Property(
|
||||
* property="id",
|
||||
* type="int",
|
||||
* example=1,
|
||||
* description="Идентификатор позиции"
|
||||
* ),
|
||||
* @OA\Property(
|
||||
* property="name",
|
||||
* type="string",
|
||||
* example="Back end - разработчик",
|
||||
* description="Название позиции"
|
||||
* ),
|
||||
*)
|
||||
*/
|
||||
class Position extends \common\models\Position
|
||||
{
|
||||
|
||||
}
|
||||
110
frontend/modules/api/models/Request.php
Normal file
110
frontend/modules/api/models/Request.php
Normal file
@ -0,0 +1,110 @@
|
||||
<?php
|
||||
|
||||
namespace frontend\modules\api\models;
|
||||
|
||||
/**
|
||||
* @OA\Schema(
|
||||
* schema="Request",
|
||||
* @OA\Property(
|
||||
* property="id",
|
||||
* type="int",
|
||||
* example=12,
|
||||
* description="Идентификатор запроса"
|
||||
* ),
|
||||
* @OA\Property(
|
||||
* property="title",
|
||||
* type="string",
|
||||
* example="PHP Developer",
|
||||
* description="Идентификатор пользователя"
|
||||
* ),
|
||||
* @OA\Property(
|
||||
* property="created_at",
|
||||
* type="datetime",
|
||||
* example="2023-04-07 02:09:42",
|
||||
* description="Дата и время создания"
|
||||
* ),
|
||||
* @OA\Property(
|
||||
* property="updated_at",
|
||||
* type="datetime",
|
||||
* example="2023-04-10 16:20:48",
|
||||
* description="Дата и время обновления"
|
||||
* ),
|
||||
* @OA\Property(
|
||||
* property="user_id",
|
||||
* type="integer",
|
||||
* example=19,
|
||||
* description="Идентификатор пользователя"
|
||||
* ),
|
||||
* @OA\Property(
|
||||
* property="position_id",
|
||||
* type="int",
|
||||
* example=1,
|
||||
* description="Идентификатор позиции"
|
||||
* ),
|
||||
* @OA\Property(
|
||||
* property="position",
|
||||
* ref="#/components/schemas/Position"
|
||||
* ),
|
||||
* @OA\Property(
|
||||
* property="skill_ids",
|
||||
* type="array",
|
||||
* @OA\Items(
|
||||
* type="integer",
|
||||
* ),
|
||||
* example="[1,2]",
|
||||
* description="Идентификаторы навыков"
|
||||
* ),
|
||||
* @OA\Property(
|
||||
* property="knowledge_level_id",
|
||||
* type="int",
|
||||
* example=2,
|
||||
* description="Идентификатор ровня разработчика"
|
||||
* ),
|
||||
* @OA\Property(
|
||||
* property="descr",
|
||||
* type="string",
|
||||
* example="Необходим разрабочик со знанием PHP и Laravel",
|
||||
* description="Идентификатор ровня разработчика"
|
||||
* ),
|
||||
* @OA\Property(
|
||||
* property="specialist_count",
|
||||
* type="int",
|
||||
* example=2,
|
||||
* description="Колличество необходимых специалистов"
|
||||
* ),
|
||||
* @OA\Property(
|
||||
* property="status",
|
||||
* type="int",
|
||||
* example=1,
|
||||
* description="Статус запроса"
|
||||
* ),
|
||||
* @OA\Property(
|
||||
* property="skills",
|
||||
* ref="#/components/schemas/SkillsExample",
|
||||
* ),
|
||||
* @OA\Property(
|
||||
* property="result_count",
|
||||
* type="int",
|
||||
* example=6,
|
||||
* description="Количество найденых профилей"
|
||||
* ),
|
||||
* @OA\Property(
|
||||
* property="level",
|
||||
* type="string",
|
||||
* example="Middle",
|
||||
* description="Текстовое наименование уровня знаний"
|
||||
* ),
|
||||
*)
|
||||
*
|
||||
* @OA\Schema(
|
||||
* schema="RequestsExample",
|
||||
* type="array",
|
||||
* @OA\Items(
|
||||
* ref="#/components/schemas/Request",
|
||||
* ),
|
||||
*)
|
||||
*/
|
||||
class Request extends \common\models\Request
|
||||
{
|
||||
|
||||
}
|
||||
41
frontend/modules/api/models/Skill.php
Normal file
41
frontend/modules/api/models/Skill.php
Normal file
@ -0,0 +1,41 @@
|
||||
<?php
|
||||
|
||||
namespace frontend\modules\api\models;
|
||||
/**
|
||||
* @OA\Schema(
|
||||
* schema="Skill",
|
||||
* @OA\Property(
|
||||
* property="id",
|
||||
* type="int",
|
||||
* example=1,
|
||||
* description="Идентификатор навыка"
|
||||
* ),
|
||||
* @OA\Property(
|
||||
* property="name",
|
||||
* type="string",
|
||||
* example="PHP",
|
||||
* description="Название навыка"
|
||||
* ),
|
||||
*)
|
||||
*
|
||||
* @OA\Schema(
|
||||
* schema="SkillsExample",
|
||||
* type="array",
|
||||
* example={{"id": 1, "name": "PHP"}, {"id": 2, "name": "Yii2"}},
|
||||
* @OA\Items(
|
||||
* type="object",
|
||||
* @OA\Property(
|
||||
* property="id",
|
||||
* type="integer",
|
||||
* ),
|
||||
* @OA\Property(
|
||||
* property="name",
|
||||
* type="string",
|
||||
* ),
|
||||
* ),
|
||||
*)
|
||||
*/
|
||||
class Skill extends \common\models\Skill
|
||||
{
|
||||
|
||||
}
|
||||
Reference in New Issue
Block a user