Inicio>código fuente PHP>Otras categorias
Descargar

Apito

REST Tutorial API utilizando la aplicación Phalcon Micro

  • Para el desarrollo de esta aplicación simple, utilizo la base de datos de prueba ubicada dentro de la aplicación ( api_teste.sql ), uso las configuraciones existentes dentro de app/config/ para configuraciones de la base de datos y para un fácil uso de Model y ModelsManager ;
  • La aplicación principal está dentro de public/index.php (o la aplicación Bootstrap ), reemplazando la forma estándar de aplicación. Utilizo la aplicación Micro() que habilita una aplicación de rendimiento rápido y también permite el uso de API ;

Estructura del método:

Conseguir Obtener ($ ID) Correo Poner Borrar
DATOS Devuelve todo Devuelve uno Insertar nuevos datos Cambia los datos existentes Elimina los datos existentes

Modo de desarrollo de aplicaciones:

Después de crear el proyecto, debemos seguir los siguientes pasos:

  1. Hacer el cambio de public/index.php use PhalconMvcMicro; y hizo referencia a la aplicación como una aplicación micro, $app = new Micro($di); ;
  2. Debemos cambiar nuestra configuración de base de datos ubicada en el archivo app/config/config.php ;
  3. Use Phalcon-Cli para crear el modelo que se utilizará;
  4. Dentro de index.php debemos usar el siguiente esqueleto de desarrollo: 
 $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();
  1. Por piezas ingresaremos a la búsqueda bancaria y a los datos para el envío a través de la API .
  2. Comenzaremos con el primer Get , insertando el PHQL que se utilizará, utilizando el modelsManager que se creó junto con Micro Application debemos usar el PHQL creado para ser interpretado, después de que se devuelvan los datos, usaremos una Array de datos para almacenar todos los datos encontrados en la consulta y finalmente debemos codificar nuestra Array para enviar en forma 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);
	}
);
  1. Aún trabajando con Get, crearemos la misma estructura que la anterior, pero recibiremos una variable $id que se pasará a la URL API . La variable recibida sufre un tratamiento usando {id:[0-9]+} , donde determinamos su nombre seguido del tipo de datos que puede recibir, en este caso, limitando los datos solo para los datos enteros, para que podamos filtrar nuestra consulta PHQL para que solo devuelva una Array de datos específica. 
 /*
* 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);
	}
);
  1. Cambiando ahora para publicar, crearemos una estructura similar a la anterior, pero en lugar de devolver los datos, usaremos el RESPONSE() para enviar el estado de la aplicación y también devolveremos los datos que se guardaron. Para esto debemos crear una nueva Array para hacer nuestra inserción, donde recibirá los datos de los nombres y se creará a través de la publicación .
  2. Después de buscar en la base de datos, comenzaremos una nueva instancia del Response() , que nos permite enviar códigos de estado (como 201, 404, 500, 401, 409 ).
  3. Después de instanciar la variable de respuesta, verificaremos si el estado de nuestra búsqueda bancaria ha devuelto el éxito, de ser así, determinaremos una respuesta con el estado 201 , devolveremos de nuestro modelo los datos creados y enviaremos una respuesta a través del contenido JSON que pase nuestro estado y los datos devueltos de nuestro modelo.
  4. Si nuestra inserción ha sido sin éxito, enviaremos un código de estado 409 , almacenaremos todos los mensajes de error encontrados dentro de una Array y enviaremos una respuesta a través del contenido JSON al pasar nuestro estado y todos los errores encontrados. 
 // 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;
	}
);
  1. En nuestro puesto, crearemos una estructura totalmente similar a la anterior, pero en nuestra URL enviamos una variable $id para que se use para modificar un datos específicos y enviando nuestro mensaje de éxito no enviaremos los datos modificados, y solo se envían los mensajes de estado. 
 // 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;
	}
);
  1. Finalmente, nuestro Delete tendrá una estructura similar a la PUT , diferenciando solo la consulta PHQL utilizada. 
 // 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;
	}
);
  1. Nuestra API se crea con éxito, ya que la ejecutaremos a través de Localhost , debemos seguir la siguiente estructura:
    • http://localhost/NOME_DO_PROJETO/api/NOME_DA_TABELA .

Recomendaciones:

  • Como recomendación para las pruebas API , recomiendo usar Postman para el trabajo.
  • Si desea integrar esta aplicación REST en su sistema, recuerde cambiar sus datos de archivo .htaccess ubicados en la raíz del proyecto a: 
 RewriteRule  ^$ NOME_DO_MICRO_APP/api/       [L]
RewriteRule  (.*) NOME_DO_MICRO_APP/api/$1   [L]
Expandir
Información adicional
Aplicaciones relacionadas
Recomendado para ti
Información relacionada Todo