Pokud chcete interaktivní způsob, jak odkazovat na dokumentaci a spouštět příkazy API pro produkty Rackspace Cloud, musíte rychle pracovat s produktem nebo chcete využít nové produkty nebo funkce, které nejsou dostupné v Ovládacím panelu, Pitchfork může být nástrojem pro vy.
Pitchfork je interaktivní webová aplikace API, která uživateli umožňuje rychlou interakci s produkty Rackspace Cloud. Není třeba vytahovat příkazový řádek nebo hledat, jak odesílat datové objekty pomocí příkazu cURL. Aplikace toto vše vyřídí za vás a zobrazí výsledky a odpovědi z požadavků rozhraní API produktu, které jste vznesli proti svému cloudovému účtu.
Pitchfork byl navržen tak, aby prováděl volání API a aby vám ukázal, co potřebujete pro volání API, abyste je mohli provádět pomocí jiných nástrojů nebo metod. Funkci simulace můžete použít ke kontrole datové struktury pro volání, která může sloužit jako referenční nástroj ve vašich programech Rackspace API.
API mohou být pro začátečníky matoucí. Vzhledem k tomu, že Pitchfork nabízí strukturu volání za vás, můžete se učit mnohem rychleji. Někdy je API jediným způsobem, jak provést změnu konfigurace například na nástroji pro vyrovnávání zatížení nebo cloudové databázi, a Pitchfork vám může ukázat, jak volání provést, a provést jej za vás.
Kde najít Pitchfork
K Pitchforku se dostanete na následující adrese:https://pitchfork.rax.io
Podívejte se na kód na GitHubu.
Požadavky na přihlášení
Nemusíte se přihlašovat do aplikace, abyste zesměšňovali nebo procházeli volání API. Musíte se přihlásit pouze v případě, že chcete provádět tato volání proti vašemu účtu.
Chcete-li se přihlásit, klikněte na Přihlásit se a zadejte své ověřovací údaje.
Ověření
Pitchfork používá stejné přihlašovací údaje, které používáte v žádosti o ověření API do cloudu Rackspace. Zadáte své uživatelské jméno a klíč API a systém za vás provede požadavek na ověření přes HTTPS. Pokud požadavek uspěje, aplikace uloží token a katalog služeb, který se vrátí, a vyprší platnost relace spolu s tokenem, až na to přijde čas.
Použijte Pitchfork k odeslání volání API
Po přihlášení použijte k odeslání volání API pomocí Pitchfork následující kroky:
- Projděte některý z produktů a najděte hovor, který chcete provést.
- Vyberte oblast, se kterou chcete komunikovat.
- Klikněte na Podrobnosti .
- Pokud pro volání existují nějaké proměnné, zadejte je.
- Klikněte na Odeslat volání API .
Aplikace vám zobrazí následující informace:
-
Adresa URL požadavku: Plně vytvořená adresa URL, na kterou jste odeslali volání.
-
Záhlaví požadavků: Část záhlaví požadavku, který jste odeslali do rozhraní API.
-
Požadavek na datový objekt: Pokud existuje datový objekt, který byl vytvořen pro volání, zobrazí se včetně hodnot, které jste zadali.
-
Záhlaví odpovědí: Záhlaví přijatá v odpovědi z rozhraní API.
-
Tělo odpovědi: Data odezvy ze serveru API. Tato odpověď může obsahovat stavový kód, vrácený objekt nebo chybovou zprávu.
-
Poznámka: Záhlaví odpovědí a tělo odpovědi se zobrazují pouze pro provedená volání, nikoli pro simulovaná volání. Vzhledem k tomu, že simulace nejsou prováděny, neexistuje žádná odezva k zobrazení.
Vysmívání
Možnost simulace vám umožňuje vytvořit hovor bez jeho provedení, takže můžete vidět, jak je hovor strukturován. Klikněte na Mock API Call když chcete vidět všechny podrobnosti požadavku na hovor. Datový objekt požadavku, pokud existuje, je zobrazen se všemi možnostmi dostupnými pro volání a pro informaci můžete vidět, jak je objekt strukturován.
Upozornění pro provedení hovoru
Když jste přihlášeni, hovory se provádějí proti vašemu cloudovému účtu. U hovorů jsou poznámky, které vás varují, když děláte něco, co ovlivní fakturaci, takže při provádění hovorů buďte opatrní.
Když zesměšňujete volání, neprovede se žádné volání API, takže to nebude mít žádný dopad na váš účet.
Historie hovorů
Historii hovorů, které jste uskutečnili, můžete snadno zobrazit kliknutím na Historie v nabídce. Historie zobrazuje hovory, které jste uskutečnili, spolu se všemi podrobnostmi. Historie se ukládá pro volání, která jste provedli proti API, bez ohledu na odpověď. Mock API volání se nezaznamenávají do vaší historie. Abyste viděli svou historii, musíte být přihlášeni.
Historie volání se ukládá, abyste mohli auditovat nebo odkazovat na minulá volání uskutečněná v rámci systému. To je užitečné, když více uživatelů používá stejnou sadu přihlašovacích údajů. Historie volání obsahuje následující prvky:
-
Dokončeno: Časové razítko, kdy byl hovor uskutečněn (časové pásmo UTC).
-
Podrobnosti hovoru: Podrobnosti o hovoru včetně popisu, adresy URL dokumentace a názvu.
-
Oblast: Oblast, kde jste provedli volání, například DFW nebo ORD.
-
Požadavek: Části požadavku, které jsou uloženy pro referenci, zahrnují URL, sloveso a jakýkoli datový objekt předaný do API.
-
Odpověď: Tělo odpovědi, záhlaví odpovědi a kód odpovědi.
-
Uživatelské jméno: Uživatelské jméno uživatele, který provádí volání proti API.
-
Číslo účtu: Číslo cloudového účtu.
Často opakované hovory
Pokud často provádíte hovor, klikněte na ikonu hvězdičky vedle hovoru. Tím se přidá mezi vaše oblíbené a k těmto hovorům budete mít přístup z úvodní stránky nebo z Oblíbených v nabídce. Své oblíbené položky můžete přidat nebo zobrazit pouze tehdy, když jste přihlášeni do aplikace.