Tworzenie API - PHP

Question

Hej mam za zadanie stworzyć podstawowe API w języku PHP, które pobierając dane z bazy danych realizuje dwie funkcjonalności, zwrócenie listy obiektów z bazy danych i jeszcze zwrócenie elementu o konkretnym ID. Ponadto utwórzyć aplikację lub stronę www, która będzie to API wywoływać.

 

Wytlumaczyłby mi ktoś jak się za to zabrać jak takie coś zacząć robic kroczek po kroczku? Ewentualnie jakieś tutoriale zarzucić??

Answer 1

Hej,

nie do konca rozumiem co oznacza "podstawowe" API, ale zakladam ze chodzi o cos takiego, zeby np pod adresem /books zostala zwrocona lista ksiazek z bazy, a pod adresem /book/8 zostaly zwrocone dane ksiazki z ID = 8 z bazy. Jedyna roznica w stosunku do "standardowej" strony jest taka, ze zamiast htmla z np tabelka z lista ksiazek masz zwrocic same dane np w formacie json czy xml.

Czyli uruchamiajac strone /books w przegladarce wyswietli ci sie cos takiego:

[ { "id": 1, "title": "Ania z Zielonego Wzgorza"}, { "id": 2, "title": "W pustyni i w puszczy" }

 

A wchodzac na strone /book/2 np:

{"id": 2, "title": "W pustyni i w puszczy", "author": "Henryk Sienkiewicz" }

Czyli taki skrypt dla listy ksiazek wyglada mniej wiecej tak:

1. Polaczenie z baza i odpowiednie zapytanie o liste ksiazek
2. Cala liste ksiazek zamieniasz na JSON funkcja json_encode($books);
3. Wyswietlasz jsona, normalnie echo (bez zadnych template'ow, htmla itp)

I podobnie dla szczegolow ksiazki (zwrocenie elementu o konkretnym id) - bedzie sie roznilo tylko zapytaniem do bazy.

Z kolei druga czesc zadania, czyli frontend, bedzie polegala na tym ze stworzysz szablon htmla z odpowiednimi id elementow, do ktorych chcesz dane "wstrzyknac". Do samego zapytania do API mozesz uzyc np jquery.

Zazwyczaj przy tworzeniu API dochodzi jeszcze kwestia autoryzacji, ale to chyba nie wchodzi w zakres "podstawowego API".

 

Jesli chcesz to API zrobic na Symfony mozesz uzyc sobie NelmioApiBundle do dokumentacji (fajnie sie testuje API, https://github.com/nelmio/NelmioApiDocBundle) i jmsSerializera (http://jmsyst.com/bundles/JMSSerializerBundle)

Comments

	function get_app_list(){
		$app_facebook = array("id" => "1", "app_name" => "Facebook", "app_price" => "Free", "app_version" => "2.0");
		$app_instagram = array("id" => "2", "app_name" => "Instagram", "app_price" => "Free", "app_version" => "2.0");
		$app_mailbox = array("id" => "3", "app_name" => "Mailbox", "app_price" => "1.9", "app_version" => "2.1");
		
		$app_list = array($app_facebook, $app_instagram, $app_mailbox);
		
		return $app_list;
	}

Zaczynam tworzyć api i mam coś takiego /\, powinnam w tego miejsce wykonac 3 zapytania do bazy czyli:

wyszukaj wszystkie ksiazki o id=1

wyszukaj wszystkie ksiazki o id=2

wyszukaj wszystkie ksiazki o id=3

i w kazda z tych zmiennych dane przypisac json_encode() tak??

 

I czy

  $app_info = file_get_contents('http://{Your Website}/api.php?action=get_app&id=' . $_GET["id"]);
  $app_info = json_decode($app_info, true);

W takim przypadku API musi byc na serverze czy mozna przy localhost?

---

zamiast array pisz   [], pisz też w php7..
To mi wygląda na jakieś skopiowane coś: )

Zamiast jej polecać coś  tak dużego lepiej coś mikro.

https://www.cloudways.com/blog/simple-rest-api-with-slim-micro-framework/

Jeśli to nie problem, użyj slima/silexa to zabawy z API, ewentualnie popatrz jak to wygląda i spróbuj napisać od zera, ale będziesz musieć wiedzieć co to REQUEST itd.

---

Tylko powiedz mi czy API by działało musi być na serwerze czy przez localhost tez zadziała?

---

Request do API musi przejsc przez apacha i php. Jesli masz postawionego apacha pod localhost to bedzie ok.

Co do serializowania, mozesz zrobic jedna tablice apps i podac do json_encode();

php> $apps = [['id' => 1, 'name' => 'Facebook'], ['id' => 2, 'name' => 'Instagram']];

php > echo json_encode($apps, JSON_PRETTY_PRINT);
[
    {
        "id": 1,
        "name": "Facebook"
    },
    {
        "id": 2,
        "name": "Instagram"
    }
]

 

---

apacha  nginx :) 

Answer 2

Po pierwsze to poczytaj o podstawach PHP i jakieś bazy, np. MySQL. Do stworzenia aplikacji będziesz jeszcze potrzebował HTML/CSS (ewentualnie JS, ale nie wiem jak rozbudowana ma to być aplikacja).

Generalnie nikt Ci tu gotowca nie da raczej, proponuję, żebyś zaczął od nauki PHP/MySQL i w razie czego zadawał konkretne pytanka to pomożemy.

Comments

Mam te podstawy, tylko nie wiem jak się za to zabrać, nie oczekuję gotowca tylko opisu jak to zrobić :/

---

@Tomasz Sochacki jaki to ma związek z tematem? HTML/CSS do api?

---

@Vento, ma się to do ostatniej części wpisu autora wątku

"Ponadto utworzyć aplikację lub stronę www, która będzie to API wywoływać."

 

---

Po pierwsze soap/rest?

---

Faktycznie. Przepraszam nie doczytałem do końca :)

---

Nie wiedziałem, że HTML/CSS wywołuje API...

---

@jpacanowski zapewne chodziło o wizualizacje danych..

Answer 3

No to tak:

Tworzysz tzw. Endpointy dla swojego API, czyli np. Pliki, które są wywoływane przez użytkownika, poprzez wysłanie requesta do tegoż pliku. Hasła do googlowania: RESTful, SOAP.

Endpointy nie muszą być koniecznie plikiem. Równie dobrze możesz zrobić jeden plik, tzw. Router, lub frontController, do którego trafiają wszystkie requesty do domeny, i na podstawie adresu URL lub zmiennych GET jest wywoływany odpowiedni kontroler / funkcja / plik etc. Po odebraniu requesta razem z danymi od użytkownika wysłanymi poprzez np. Metody GET, POST, PUT etc. możesz użyć tych danych np. do wygrania z bazy rekordu, zwrócić dane w postaci JSON i to tyle :)