Katalogu i Shërbimeve Web
Katalogu i Shërbimeve Web është një vend i zakonshëm ku dokumentacioni i API-ve ndodhet.
Në këtë kornizë, mund të lexoni, kopjoni dhe testoni metoda të ndryshme dhe t'i përshtatni ato sipas nevojave tuaja.
Tabela e përmbajtjes
- Header
- Parametrat
- Përgjigjet
- Skemat
|
1. Header
Header i një shembulli individual të API-së PANTHEON përmban informacion mbi metodën e operacionit që po përdoret, pikën fundore të API-së në raport me URL-në bazë, përshkrimin e një veprimi të treguar dhe një shembull funksional të një kërkese:
- Metodat e operacionit të përdorura
- Pika fundore
- Përshkrimi
- Shembull i një kërkese
Metodat e operacionit në API-në PANTHEON:
|
|
Rikthen të dhëna nga serveri.
|
|
|
Krijon regjistrime të reja në bazën e të dhënave ose rikthen të dhëna nga serveri.
|
|
|
Përditëson regjistrimet ekzistuese.
|
2. Parametrat
Në Parametrat, tregohet një shembull i një kërkese pa vlera.
Duke klikuar Provoje butonin, hapet redaktuesi i kërkesave dhe mund të përgatitni kërkesat tuaja.
Pasi të dhënat ose kërkesa të jenë futur, mund të ekzekutoni metodën duke zgjedhur Ekzekuto butonin. Nëse dëshironi të dilni nga redaktuesi, zgjidhni Anulo butonin.
2.1 Fusha e parametrave
Në disa API, të dhënat mund të futen gjithashtu në Parametrat fushën:
2.1.1 Fusha e hyrjes
Në fushën e parametrave Ident, mund të futni artikullin tuaj.
2.1.2 Trupi i kërkesës
Në trupin e kërkesës, mund të futni kërkesën tuaj ose të redaktoni shembullin e kërkesës.
3. Përgjigjet
Në Përgjigjet, rezultatet tregohen pasi kërkesa të jetë ekzekutuar.
Përgjigjet përfshijnë:
- cURL
- URL e kërkesës
- Përgjigja e serverit
3.1 cURL
Përmban një mjet komandash cURL me parametrat e kërkesës së ekzekutuar. Me ikonën e kopjimit në cepin e poshtëm të djathtë, mund të kopjoni lehtësisht linjën cURL në clipboard.
3.2 URL e kërkesës
Përmban URL-në që është përdorur nga metoda. Përbëhet nga një metodë HTTPS, një URL bazë dhe një pikë fundore ose URI burimi.
3.3 Përgjigja e serverit
Tregon rezultatet e një kërkese të ekzekutuar me sukses.
Header-at e përgjigjes përmbajnë informacion mbi llojin e përmbajtjes, charset-in, kohën dhe serverin e kërkesës 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ë cepin e poshtëm të djathtë.
Kodet e treguara në Përgjigjet tregojnë statusin e kërkesës së ekzekutuar.
|
200
|
Sukses: ekzekutuar me sukses.
|
|
500
|
Gabim: përshkrimi i një gabimi.
|
4. Skemat
Skemat përmbajnë informacion mbi strukturën e të dhënave të objekteve.
Një skemë specifike ofron një përshkrim të objektit të specifikuar.
