Web Services - Historial de revisió

Enric: /* Crides cURL en PHP */

2019-03-21T15:06:14Z

Crides cURL en PHP

Enric: /* Crides cURL en PHP */

2019-03-21T15:04:55Z

Crides cURL en PHP

Enric: /* Exemple d'accés a un web service extern (Musicbrainz) */

2019-03-21T14:59:29Z

Exemple d'accés a un web service extern (Musicbrainz)

Enric: /* Especificació d'un Web Service */

2019-03-21T14:48:46Z

Especificació d'un Web Service

Enric: /* Obtenir llista de canals i missatges */

2018-03-02T18:15:46Z

Obtenir llista de canals i missatges

Enric: /* Obtenir llista de canals i missatges */

2018-03-02T18:14:57Z

Obtenir llista de canals i missatges

Enric: /* Enviar un missatge */

2018-03-02T18:09:57Z

Enviar un missatge

Enric: /* Obtenir llista de canals i missatges */

2018-03-02T18:07:25Z

Obtenir llista de canals i missatges

Enric: /* Obtenir llista de canals i missatges */

2018-03-02T18:06:05Z

Obtenir llista de canals i missatges

Enric: /* Especificació d'un Web Service */

2017-03-10T11:23:27Z

Especificació d'un Web Service

@@ Línia 80: / Línia 80: @@
 curl_setopt($c, CURLOPT_HTTPHEADER, array('Content-Type:application/json','Accept:application/json','User-Agent:Laravel/5.7'));
 // ajustos perquè ens retorni les dades sobre una variable
-curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
+curl_setopt($c, CURLOPT_RETURNTRANSFER, true);
 // cridem per obtenir les dades
@@ Línia 89: / Línia 89: @@
 // mostrem nom ($dades ja és un array associatiu PHP)
-echo $dades["aliases"][0]["name"]
+echo $dades["aliases"][0]["name"];
 </syntaxhighlight>

@@ Línia 85: / Línia 85: @@
 $res = curl_exec($c);
-// printem
+// transformem les dades a un array associatiu de PHP
-echo $res;
+$dades = json_decode($res,true);
 </syntaxhighlight>

@@ Línia 51: / Línia 51: @@
 == Exemple d'accés a un web service extern (Musicbrainz) ==
-Normalment accedit amb la comanda ''curl'' des de la pròpia ''shell'':
+Normalment accedit amb la comanda ''curl'' des de la pròpia ''shell''. Primer cal instal·lar-la:
 Exploreu els següents recursos:
@@ Línia 60: / Línia 61: @@
 Exemple:
- $ curl -H 'Accept:application/json'  http://musicbrainz.org/ws/2/artist/5b11f4ce-a62d-471e-81fc-a69a8278c7da?inc=aliases | python3 -m json.tool
+<syntaxhighlight lang="bash">
 == Especificació d'un Web Service ==

← Versió més antiga		Revisió del 14:48, 21 març 2019
Línia 49:		Línia 49:

	<br>		<br>
		+
		+	== Exemple d'accés a un web service extern (Musicbrainz) ==
		+	Normalment accedit amb la comanda ''curl'' des de la pròpia ''shell'':
		+
		+	Exploreu els següents recursos:
		+	* API (respon en XML): https://musicbrainz.org/doc/Development/XML_Web_Service/Version_2
		+	* Crides en JSON: https://musicbrainz.org/doc/Development/JSON_Web_Service
		+	* Per obtenir les dades en JSON cal que adjunteu el //header// de curl "Accept:application/json"
		+	* Per fer //pretty print// d'un JSON va molt bé "empipar-lo" a aquesta comanda:<code>$ curl ... \| python3 -m json.tool</code>
		+
		+	Exemple:
		+	$ curl -H 'Accept:application/json' http://musicbrainz.org/ws/2/artist/5b11f4ce-a62d-471e-81fc-a69a8278c7da?inc=aliases \| python3 -m json.tool
		+
		+
		+

	== Especificació d'un Web Service ==		== Especificació d'un Web Service ==

@@ Línia 66: / Línia 66: @@
 {| border="1" class="wikitable" style="border-collapse:collapse;"
-!colspan="3"| GET &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; http://exemple.com/api/xat &nbsp;&nbsp;&nbsp;&nbsp; (entrada ''plain text'')
+!colspan="3"| GET &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; http://exemple.com/api/xat
 |-
-!colspan="3"| REQUEST
+!colspan="3"| REQUEST (entrada ''plain text'')
 |-
 ! Paràmetre
@@ Línia 78: / Línia 78: @@
 | canal de xat del què volem rebre els missatges
 |-
-!colspan="3"| RESPONSE
+!colspan="3"| RESPONSE (JSON)
 |-
 ! Paràmetre

@@ Línia 101: / Línia 101: @@
 === Enviar un missatge ===
 {| border="1" class="wikitable" style="border-collapse:collapse;"
-!colspan="3"| REQUEST
+!colspan="3"| POST http://exemple.com/api/xat
 |-
-!colspan="3"| POST http://exemple.com/api/xat (entrada JSON)
+!colspan="3"| REQUEST (entrada JSON)
 |-
 ! atribut
@@ Línia 120: / Línia 120: @@
 | string
 | cos dels missatge a enviar
 |-
-!colspan="3"| POST http://exemple.com/api/xat (sortida JSON)
+!colspan="3"| RESPONSE (JSON)
 |-
 ! atribut

@@ Línia 53: / Línia 53: @@
 Abans de posar-nos a treballar cal fer una correcta especificació. En aquest cas encara és més important ja que el codi estarà separat en 2 blocs: client (JS) i servidor (WS). Sol ser molt comú repartir en especialistes de cada part els dos blocs, i perquè el projecte funcioni cal que l'especificació sigui clara.
-En aquest cas tenim un exemple d'un xat. Veureu que cada servei o ''endpoint'' necessita una especificació de les dades que necessita que li entrem (enviar) i quines ens donarà.
+Tenim 2 exemples:
@@ Línia 62: / Línia 66: @@
 {| border="1" class="wikitable" style="border-collapse:collapse;"
-!colspan="3"| REQUEST - GET http://exemple.com/api/xat (entrada GET)
+!colspan="3"| REQUEST
 |-
 ! Paràmetre
@@ Línia 69: / Línia 75: @@
 |-
 | canal
-| principal
+| string
 | canal de xat del què volem rebre els missatges
 |}
 {| border="1" class="wikitable" style="border-collapse:collapse;"
-!colspan="3"| RESPONSE - GET http://exemple.com/api/xat (sortida JSON)
+!colspan="3"| RESPONSE
 |-
 ! Paràmetre
@@ Línia 106: / Línia 114: @@
 |-
 | canal
-| daw_masters
+| string
 | canal de xat al què volem enviar el missatge
 |-
 | nick
-| enricus
+| string
 | nom del remitent
 |-
 | missatge
-| "hola, com anem per aquí?"
+| string
 | cos dels missatge a enviar
 |}
@@ Línia 132: / Línia 140: @@
 |-
 | canal
-| "principal"
+| string
 | canal de xat al què hem volgut enviar el missatge
 |-
@@ Línia 140: / Línia 148: @@
 |-
 | missatge
-| "ERROR: JSON incorrecte"<br>"missatge enregistrat correctament"
+| text
-| missatge amb detalls de l'execució
+| missatge amb detalls de l'execució, per ex:<br> "ERROR: JSON incorrecte"<br>"missatge enregistrat correctament"
 |}