Fejlesztés a REST API-kkal Power BI jelentéskészítő kiszolgáló

  • Cikk

Power BI jelentéskészítő kiszolgáló támogatja a Reprezentációs állapotátviteli (REST) API-kat. A REST API-k olyan szolgáltatásvégpontok, amelyek HTTP-műveletek (metódusok) készletét támogatják, amelyek hozzáférést biztosítanak a jelentéskészítő kiszolgáló erőforrásaihoz, lekéréséhez, frissítéséhez vagy törléséhez.

A REST API programozott hozzáférést biztosít az objektumokhoz egy Power BI jelentéskészítő kiszolgáló katalógusban. Ilyenek például a mappák, jelentések, KPI-k, adatforrások, adathalmazok, frissítési csomagok, előfizetések stb. A REST API használatával például navigálhat a mappahierarchiában, felderítheti egy mappa tartalmát, vagy letöltheti a jelentésdefiníciót. Objektumokat is létrehozhat, frissíthet és törölhet. Az objektumok használatával például feltölthet egy jelentést, végrehajthat egy frissítési tervet, törölhet egy mappát stb.

Feljegyzés

Ha meg szeretné tekinteni vagy törölni szeretné a személyes adatokat, tekintse át a Microsoft útmutatását a GDPR-webhelyre vonatkozó Windows-adattulajdonosi kérelmekben. Ha általános információkat keres a GDPR-ról, tekintse meg a Szolgáltatásmegbízhatósági portál GDPR szakaszát.

REST API-kérés/válasz összetevői

A REST API-kérés-/válaszpárok öt összetevőre oszthatók:

  • A kérelem URI-ja, amely a következőkből áll: {URI-scheme} :// {URI-host} / {resource-path} ? {query-string}. Bár a kérelem URI-ja szerepel a kérelemüzenet fejlécében, itt külön hívjuk meg, mert a legtöbb nyelv vagy keretrendszer megköveteli, hogy a kérésüzenettől elkülönítve adja át.

    • URI-séma: A kérés továbbításához használt protokollt jelzi. Például, http vagy https.
    • URI-gazdagép: Annak a kiszolgálónak a tartománynevét vagy IP-címét adja meg, ahol a REST-szolgáltatásvégpont üzemel, például myserver.contoso.com.
    • Erőforrás elérési útja: Megadja az erőforrást vagy az erőforrásgyűjteményt, amely több szegmenst is tartalmazhat, amelyeket a szolgáltatás használ az erőforrások kiválasztásának meghatározásához. Például: CatalogItems(01234567-89ab-cdef-0123-456789abcdef)/Properties a CatalogItem megadott tulajdonságainak lekérésére használható.
    • Lekérdezési sztring (nem kötelező): További egyszerű paramétereket biztosít, például az API-verziót vagy az erőforrás-kiválasztási feltételeket.

  • HTTP-kérés üzenetfejlécmezői:

    • Egy szükséges HTTP-metódus (más néven művelet vagy ige), amely közli a szolgáltatással, hogy milyen típusú műveletet kér. A Reporting Services REST API-k támogatják a DELETE, a GET, a HEAD, a PUT, a POST és a PATCH metódusokat.
    • A megadott URI- és HTTP-metódus által megkövetelt további fejlécmezők megadása nem kötelező.

  • Az URI és a HTTP művelet támogatásához választható HTTP-kérési üzenet törzsmezői . A POST-műveletek például összetett paraméterekként átadott MIME-kódolt objektumokat tartalmaznak. POST vagy PUT műveletek esetén a törzs MIME-kódolási típusát is meg kell adni a Content-type kérelem fejlécében. Egyes szolgáltatásokhoz egy adott MIME-típust kell használnia, például application/json.

  • HTTP-válaszüzenet fejlécmezői :

    • EGY HTTP-állapotkód, amely a 2xx sikerkódtól a 4xx vagy 5xx hibakódig terjed. Másik lehetőségként egy szolgáltatás által definiált állapotkódot is visszaadhat az API dokumentációjában leírtak szerint.
    • A kérés válaszának támogatásához szükséges további fejlécmezők( például válaszfejléc Content-type ) megadása kötelező.

  • Nem kötelező HTTP-válaszüzenet törzsmezői :

    • A MIME kódolású válaszobjektumok a HTTP-válasz törzsében jelennek meg, például az adatokat visszaküldött GET metódus válaszaként. Ezek az objektumok általában strukturált formátumban, például JSON-ban vagy XML-ben jelennek meg, a Content-type válaszfejlécnek megfelelően.

API-dokumentáció

A modern REST API modern API-dokumentációt igényel. A REST API az OpenAPI-specifikációra (más néven a swagger specifikációjára) épül, és a dokumentáció elérhető a Microsoft Learnben.

API-hívások tesztelése

A HTTP-kérések/válaszüzenetek tesztelésére szolgáló eszköz a Fiddler. A Fiddler egy ingyenes webes hibakeresési proxy, amely képes elfogni a REST-kéréseket, így könnyen diagnosztizálható a HTTP-kérések/ válaszüzenetek.

Kapcsolódó tartalom

Tekintse át az elérhető API-kat a Microsoft Learnben.

A minták a GitHubon érhetők el. A minta egy TypeScriptre, Reactre és webpackre épülő HTML5-alkalmazást és egy PowerShell-példát tartalmaz.

Van még esetleg kérdése? Kérdezze meg a Power BI-közösség