apituto

apituto

Другие категории

1.0.0

Скачать

Апитус

Учебник API с использованием Phalcon Micro Application

Для разработки этого простого приложения я использую тестовую базу данных, расположенную в приложении ( api_teste.sql ), я использую существующие конфигурации в app/config/ для конфигураций базы данных и для легкого использования разрешения модели и Models Manager ;
Основное приложение находится в public/index.php (или Bootstrap Application), заменяя стандартную форму приложения. Я использую приложение Micro() , которое обеспечивает быстрое применение производительности, а также позволяет использовать API ;

Структура метода:

	Получать	Получить ($ id)	Почта	Помещать	Удалить
ДАННЫЕ	Возвращает все	Возвращает один	Вставьте новые данные	Изменяет существующие данные	Удаляет существующие данные

Режим разработки приложений:

После создания проекта мы должны выполнить следующие шаги:

Сделайте изменение public/index.php важным use PhalconMvcMicro; и ссылались на приложение как на микро -приложение, $app = new Micro($di); ;
Мы должны изменить настройки базы данных, расположенные в файле app/config/config.php ;
Используйте Phalcon-Cli , чтобы создать модель для использования;
Внутри index.php мы должны использовать следующий скелет разработки:

 $app = new Micro($di);

// Utiliza a API e através do método GET, RETORNA TODOS OS DADOS.
$app->get(
	"/api/dados",
	function () use ($app) {

	}
);

/*
* Utiliza a API e através do método GET, RETORNA APENAS UM DADO.
* Nota: Ele receberá como GET um ID que terá um tratamento através do ':[0-9]+' 
* permitindo assim que o mesmo seja somente do tipo INTEIRO.
*/
$app->get(
	"/api/dados/{id:[0-9]+}",
	function ($id) use ($app) {

	}
);

// Utiliza a API e através do método POST, INSERE UM NOVO DADO.
$app->post(
	"/api/dados",
	function () use ($app) {

	}
);

// Utiliza a API e através do método PUT, ALTERA UM DADO EXISTENTE respeitando o tratamento do ID.
$app->put(
	"/api/dados/{id:[0-9]+}",
	function ($id) use ($app) {

	}
);

// Utiliza a API e através do método DELETE, REMOVE UM DADO EXISTENTE respeitando o tratamento do ID.
$app->delete(
	"/api/dados/{id:[0-9]+}",
	function () {

	}
);

$app->handle();

По частям мы введем поиск в банке и данные данных для доставки через API .
Мы начнем с первого GET , вставив PHQL , который будет использоваться, используя modelsManager , который был создан вместе с Micro Application мы должны использовать PHQL , созданный для интерпретации, после возвращения данных мы будем использовать Array данных для хранения всех данных, найденных в запросе, и, наконец, мы должны кодифицировать нашу Array , чтобы отправить форму JSON .

 // Utiliza a API e através do método GET, RETORNA TODOS OS DADOS.
$app->get(
	"/api/dados",
	function () use ($app) {
		$phql = "SELECT * FROM dados";
		$dados = $app->modelsManager->executeQuery($phql);
		$data = [];
		foreach($dados as $dado){
			$data[] = [
				'id'      => $dado->id,
				'nome'    => $dado->nome,
				'criado'  => $dado->criado
			];
		}
		echo json_encode($data);
	}
);

Все еще работая с Get, мы создадим ту же структуру, что и предыдущая, но получив переменную $id , которая будет передана в URL . Полученная переменная подвергается обработке с использованием {id:[0-9]+} , где мы определяем его имя, за которым следует тип данных, которые он может получить, в данном случае ограничивая данные только для данных целочисленного, чтобы мы могли отфильтровать наш запрос PHQL , чтобы он возвращал только одну конкретную Array данных.

 /*
* Utiliza a API e através do método GET, RETORNA APENAS UM DADO.
* Nota: Ele receberá como GET um ID que terá um tratamento através do ':[0-9]+' 
* permitindo assim que o mesmo seja somente do tipo INTEIRO.
*/
$app->get(
	"/api/dados/{id:[0-9]+}",
	function ($id) use ($app) {
		$phql = "SELECT * FROM dados WHERE id = ".$id;
		$dados = $app->modelsManager->executeQuery($phql);
		$data = [];
		foreach($dados as $dado){
			$data[] = [
				'id'      => $dado->id,
				'nome'    => $dado->nome,
				'criado'  => $dado->criado
			];
		}
		echo json_encode($data);
	}
);

Изменение сейчас, чтобы опубликовать, мы создадим структуру, аналогичную предыдущей, но вместо возврата данных мы будем использовать RESPONSE() для отправки состояния приложения, а также вернуть сохраненные данные. Для этого мы должны создать новый Array , чтобы сделать нашу вставку, где он будет получать данные имени и создан через пост .
После поиска в базе данных мы запустим новый экземпляр Response() , который позволяет нам отправлять коды состояния (например , 201, 404, 500, 401, 409 ).
После того, как мы испытали переменную ответа, мы проверим статус нашего банка поиска успеха, если это так, мы определим ответ со статусом 201 , мы вернем из нашей модели созданные данные и отправим ответ через контент JSON , передав наш статус и возвращаемые данные из нашей модели.
Если наша вставка была безуспешно, мы отправим код состояния 409 , мы сохраним все сообщения об ошибках, найденные в Array , и отправим ответ через контент JSON , передав наш статус и все найденные ошибки.

 // Utiliza a API e através do método POST, INSERE UM NOVO DADO.
$app->post(
	"/api/dados",
	function () use ($app) {
		$insert = [
			'nome' 	 => $app->request->getPost('nome'),
			'criado' => ( ($app->request->getPost('criado')) ? $app->request->getPost('criado') : date('Y-m-d H:i:s') )
		];
		$phql = "INSERT INTO dados (nome, criado) VALUES ('".$insert['nome']."', '".$insert['criado']."')";
		echo $phql;
		$status = $app->modelsManager->executeQuery($phql);

		// cria response
		$response = new Response();
		if($status->success() === true){
			$response->setStatusCode(201, "Criado");
			$dados = Dados::findFirstBynome($insert['nome']);
			$response->setJsonContent(
				[
					'status' => "ok",
					'data' => $dados
				]
			);
		} else {
			$response->setStatusCode(409, "Conflito");
			$erros = [];
			foreach ($status->getMessages() as $msg){
				$erros[] = $msg->getMessage();
			}
			$response->setJsonContent(
				[
					'status' => "Erro",
					'messages' => $erros
				]
			);
		}
		return $response;
	}
);

В нашем PUT мы создадим структуру, совершенно похожую на предыдущую, но в нашем URL мы отправим переменную $id для изменения конкретных данных и отправки нашего сообщения успеха, мы не будем отправлять измененные данные, и отправляются только сообщения о состоянии.

 // Utiliza a API e através do método PUT, ALTERA UM DADO EXISTENTE respeitando o tratamento do ID.
$app->put(
	"/api/dados/{id:[0-9]+}",
	function ($id) use ($app) {
		$update = [
			'id'		 => $id,
			'nome' 	 => $app->request->getPut('nome'),
			'criado' => $app->request->getPut('criado')
		];

		$phql = "UPDATE dados.dados SET dados.nome = '".$update['nome']."', dados.criado = '".$update['criado']."' WHERE dados.id = ".$id;
		$status = $app->modelsManager->executeQuery($phql);

		// cria response
		$response = new Response();
		if($status->success() === true){
			$response->setStatusCode(201, "Criado");
			$dados = $dados = Dados::findFirst($update['id']);
			$response->setJsonContent(
				[
					'status' => "ok",
					'data' => $dados
				]
			);
		} else {
			$response->setStatusCode(409, "Conflito");

			$erros = [];

			foreach ($status->getMessages() as $msg){
				$erros[] = $msg->getMessage();
			}

			$response->setJsonContent(
				[
					'status' => "Erro",
					'messages' => $erros
				]
			);
		}
		return $response;
	}
);

Наконец, наша удаление будет иметь структуру, похожую на пут , дифференцируя только используемый запрос PHQL .

 // Utiliza a API e através do método DELETE, REMOVE UM DADO EXISTENTE respeitando o tratamento do ID.
$app->delete(
	"/api/dados/{id:[0-9]+}",
	function () {
		$phql = "DELETE FROM dados.dados WHERE dados.id = ".$id;
		$status = $app->modelsManager->executeQuery($phql);

		// cria response
		$response = new Response();
		if($status->success() === true){
			$response->setJsonContent(
				[
					'status' => "ok"
				]
			);
		} else {
			$response->setStatusCode(409, "Conflito");
			$erros = [];
			foreach ($status->getMessages() as $msg){
				$erros[] = $msg->getMessage();
			}
			$response->setJsonContent(
				[
					'status' => "Erro",
					'messages' => $erros
				]
			);
		}
		return $response;
	}
);

Наш API создан успешно, так как мы будем запускать его через Localhost , мы должны следовать следующей структуре:
- http://localhost/NOME_DO_PROJETO/api/NOME_DA_TABELA .