Katalogu i Shërbimeve Web
Katalogu i Shërbimeve Web është një vend i zakonshëm ku ndodhet dokumentacioni i API-ve.
Në këtë kuadër, ju mund të lexoni, kopjoni dhe testoni metoda të ndryshme dhe t'i përshtatni ato nevojave tuaja.
Tabela e përmbajtjes
- Kreu
- Parametrat
- Përgjigjet
- Skemat
|
1. Kreu
Kreu i një shembulli të veçantë të API-së PANTHEON përmban informacion në lidhje me metodën e operacionit që po përdoret, pikën e fundit të API-së në lidhje me URL-në bazë, përshkrimin e një veprimi të treguar dhe një shembull funksional të një pyetje:
- Metodat e operacionit të përdorura
- Pika e fundit
- Përshkrimi
- Shembulli i një pyetje
Metodat e operacionit në API-në PANTHEON:
|
|
Merr të dhëna nga serveri.
|
|
|
Krijon regjistra të rinj në bazën e të dhënave ose merr të dhëna nga serveri.
|
|
|
Përditëson regjistrat ekzistues.
|
2. Parametrat
Në Parametrat, një shembull i një pyetje pa vlera tregohet.
Me klikimin në Provoje butonin, redaktori i pyetjeve hapet dhe ju mund të përgatitni pyetjet tuaja.
Pas hyrjes së të dhënave ose pyetjes, ju mund të ekzekutoni metodën duke zgjedhur Ekzekuto butonin. Nëse dëshironi të largoheni nga redaktori, zgjidhni Anulo butonin.
2.1 Fusha e parametrave
Në disa API, të dhënat gjithashtu mund të futen në Parametrat fushën:
2.1.1 Fusha e hyrjes
Në fushën e Parametrave Ident, ju mund të futni artikullin tuaj.
2.1.2 Trupi i kërkesës
Në trupin e kërkesës, ju mund të futni pyetjen tuaj ose të redaktoni shembullin e pyetjes.
3. Përgjigjet
Në Përgjigjet, rezultatet tregohen pas ekzekutimit të pyetjes.
Përgjigjet përfshijnë:
- cURL
- URL e kërkesës
- Përgjigja e serverit
3.1 cURL
Përmban një mjet të komandës cURL me parametrat e pyetjes së ekzekutuar. Me ikonën e kopjimit në clipboard në këndin e poshtëm të djathtë, ju mund të kopjoni lehtësisht linjën cURL në clipboard.
3.2 URL e kërkesës
Përmban URL-në që u përdor nga metoda. Ajo përbëhet nga një metodë HTTPS, një URL bazë dhe një pikë e fundit ose URI burimi.
3.3 Përgjigja e serverit
Tregon rezultatet e një pyetjeje të ekzekutuar me sukses.
Kreun e përgjigjeve përmban informacion në lidhje me llojin e përmbajtjes, charset, kohën dhe serverin e pyetjes së ekzekutuar.
Në trupin e përgjigjes, rezultatet paraqiten në formatin JSON. Ato mund të kopjohen në clipboard ose të shkarkohen si një skedar .json duke zgjedhur butonin përkatës në këndin e poshtëm të djathtë.
Kodet e shfaqura në Përgjigjet tregojnë statusin e pyetjes së ekzekutuar.
|
200
|
Sukses: ekzekutuar me sukses.
|
|
500
|
Gabim: përshkrimi i një gabimi.
|
4. Skemat
Skemat përmbajnë informacion në lidhje me strukturën e të dhënave të objekteve.
Një schema specifike ofron një përshkrim të objektit të specifikuar.
