Page d'accueil>Code source PHP>Autres catégories
Télécharger

Apitus

Reste du didacticiel de l'API à l'aide de Phalcon Micro Application

  • Pour le développement de cette application simple, j'utilise la base de données de test située dans l'application ( api_teste.sql ), j'utilise les configurations existantes dans les configurations app/config/ pour la base de données et pour une autorisation facile à utiliser de Model et ModelManager ;
  • L'application principale se situe dans public/index.php (ou le bootstrap d'application), remplaçant la forme standard de l'application que j'utilise l'application Micro() qui permet une application de performances rapides et permet également d'utiliser des API ;

Structure de la méthode:

Obtenir Obtenir ($ id) Poste Mettre Supprimer
DONNÉES Renvoie tout Renvoie un Insérer de nouvelles données Modifie les données existantes Supprime les données existantes

Mode de développement des applications:

Après avoir créé le projet, nous devons suivre les étapes suivantes:

  1. Faire le changement de public/index.php use PhalconMvcMicro; et référencé l'application en tant que micro application, $app = new Micro($di); ;
  2. Nous devons modifier nos paramètres de base de données situés dans le fichier app/config/config.php ;
  3. Utilisez Phalcon-CLI pour créer le modèle à utiliser;
  4. Dans index.php , nous devons utiliser le squelette de développement suivant: 
 $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. Par des pièces, nous entrons dans la recherche bancaire et les données Atibition pour l'expédition via l' API .
  2. Nous allons commencer par le premier Get , en insérant le PHQL qui sera utilisé, en utilisant le modelsManager qui a été créé avec Micro Application nous devons utiliser le PHQL créé pour être interprété, une fois les données renvoyées, nous utiliserons un Array de données pour stocker toutes les données trouvées dans la requête et enfin nous devons codifier notre Array à envoyer sous forme 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. En travaillant toujours avec Get, nous créerons la même structure que la précédente, mais recevant une variable $id qui sera transmise à l' URL de l'API . La variable reçue subit un traitement en utilisant {id:[0-9]+} , où nous déterminons son nom suivi du type de données qu'il peut recevoir, dans ce cas, limitant les données uniquement pour les données entières, afin que nous puissions filtrer notre requête PHQL afin qu'elle ne renvoie qu'un seul Array de données spécifique. 
 /*
* 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. En changeant maintenant en publication, nous créerons une structure similaire à la précédente, mais au lieu de renvoyer des données, nous utiliserons la RESPONSE() pour envoyer l'état de l'application et renvoyer les données enregistrées. Pour cela, nous devons créer un nouveau Array pour faire notre insertion, où il recevra les données de nom et créé via la publication .
  2. Après avoir recherché la base de données, nous démarrerons une nouvelle instance de la Response() , qui nous permet d'envoyer des codes d'état (tels que 201, 404, 500, 401, 409 ).
  3. Après avoir instancié la variable de réponse, nous vérifierons si le statut de notre recherche bancaire a renvoyé le succès, dans l'affirmative, nous déterminerons une réponse avec Status 201 , nous reviendrons de notre modèle les données créées et enverrons une réponse via le contenu JSON passant notre statut et les données renvoyées de notre modèle.
  4. Si notre insertion a été sans succès, nous enverrons un code d'état 409 , nous stockons tous les messages d'erreur trouvés dans un Array et enverrons une réponse via le contenu JSON en passant notre statut et toutes les erreurs trouvées. 
 // 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. Dans notre put, nous créerons une structure totalement similaire à la précédente, mais dans notre URL, nous envoyons une variable $id à utiliser pour modifier une données spécifique et en envoyant notre message de réussite, nous n'enverrons pas les données modifiées, et seuls les messages d'état sont envoyés. 
 // 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. Enfin, notre suppression aura une structure en forme de put , différenciant uniquement la requête PHQL utilisée. 
 // 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. Notre API est créée avec succès, car nous l'exécuterons via LocalHost , nous devons suivre la structure suivante:
    • http://localhost/NOME_DO_PROJETO/api/NOME_DA_TABELA .

Recommandations:

  • Comme recommandation pour les tests API , je recommande d'utiliser Postman pour le travail.
  • Si vous souhaitez intégrer cette application REST dans votre système, n'oubliez pas de modifier vos données de fichier .htaccess situées à la racine du projet pour: 
 RewriteRule  ^$ NOME_DO_MICRO_APP/api/       [L]
RewriteRule  (.*) NOME_DO_MICRO_APP/api/$1   [L]
Développer
Informations supplémentaires
Applications connexes
Recommandé pour vous
Actualités connexes Tout