Blog · 18. září 2023 · Steve Simpson · Integrace

Webová služba Apex: stavební kameny pro webové kouzelníky

Úvod:

V tomto článku se podívám na stavbu vlastních webových služeb Apex v Salesforce. Tyto služby jsou zásadní, když potřebujete, aby externí proces komunikoval se Salesforce kvůli čtení nebo zápisu dat, a standardní REST API nestačí. Projdeme pět příkladů s postupně rostoucí složitostí, od standardních dotazů až po aktualizace.

Diagram: pět příkladů vlastních webových služeb Apex volaných z Postmanu: GET vracející seznam záznamů, GET s objektem odpovědi, GET s parametrem, POST a POST s chybou

Přehled vlastních webových služeb

Prozkoumáme pět příkladů vlastních webových služeb:

GET se standardním seznamem SObject: Načtení dat pomocí standardního seznamu SObject.

Obal s odpovědí JSON: Vylepšení požadavku GET jeho obalením do odpovědi JSON.

Přidání parametrů: Doplnění parametrů do požadavku GET pro cílenější načítání dat.

POST pro vkládání: Implementace požadavku POST pro vkládání dat.

Vrácení chybové zprávy: Správné ošetření a vrácení chybových zpráv.

Implementace vlastních webových služeb

Příklad 1: GET se standardním seznamem SObject

V tomto příkladu definujeme prostředek REST s vlastním URI a určíme HTTP sloveso (GET). Třída musí být deklarovaná jako global a jednoduchým dotazem vracíme seznam standardních účtů.

Kód Apex: prostředek REST s metodou GET, která dotazem načte Accounts a vrátí seznam s výchozí serializací

Příklad 2: obal s odpovědí JSON

Abychom měli kontrolu nad daty posílanými zpět klientovi, použijeme objekt odpovědi. Místo seznamu SObject vracíme seznam vlastních objektů odpovědi, které představují zákazníka odlehčeně, jen s ID a jménem.

Kód Apex: metoda GET, která sestaví objekt odpovědi se seznamem zákazníků

Příklad 3: přidání parametrů

Parametry jsou nezbytné, když potřebujete data pro konkrétního zákazníka. Přečtením RestContext.params získáte ID zákazníka a použijete ho v klauzuli WHERE dotazu SOQL k filtrování dat.

Kód Apex: metoda GET, která z požadavku přečte parametr customerid a vrátí daného zákazníka v objektu odpovědi

Příklad 4: POST pro vkládání

Když potřebujete data zapsat, použije se metoda POST. V tomto příkladu vytvoříme objekt odpovědi a objekt požadavku. Objekt požadavku přijme zákazníka se jménem a serializátorem JSON převedeme požadavek na konkrétní třídu. Po vytvoření a vložení nového účtu se vrátí stav úspěchu.

Kód Apex: metoda POST, která zpracuje tělo požadavku, vloží Account a vrátí stav úspěchu nebo chyby

Příklad 5: vrácení chybové zprávy

Tento příklad je podobný příkladu 4, ale obsahuje ošetření chyb. Při výjimce se chyba zachytí, přidá do seznamu a stavový kód se nastaví na 500 (nebo na jakékoli číslo, které preferujete).

Kód Apex: metoda POST s ošetřením chyb, která vrací chybovou zprávu a stavový kód HTTP 500

Závěr

Na těchto příkladech jsme ukázali základní stavební kameny pro tvorbu vlastních webových služeb Apex v Salesforce. Začali jsme jednoduchým požadavkem GET a postupně jsme přidávali složitost: parametry, požadavky POST a ošetření chyb.

Zůstaňte naladěni

Děkuji za přečtení a těším se, že se s vámi brzy podělím o další dobrodružství plná znalostí! Zůstaňte naladěni tady na www.SteveTechArc.com a na kanálu @SteveTechArc (opens in a new tab) na YouTube. Přihlaste se k odběru a prohlubte své porozumění Salesforce a tomu, jak ho integrovat s dalšími systémy.

Pomáháme měnit svět sdílením informací o integraci s kolegy architekty a se všemi, kdo jsou na cestě k architektovi!

Přepis s pomocí AI

STA 1.8