Zdieľať cez


Rozhranie API služby Fabric pre editor GraphQL

Rozhranie API služby Fabric pre GraphQL poskytuje grafické vývojové prostredie GraphQL v prehliadači, ktoré umožňuje interaktívnemu ihrisku vytvárať, testovať a zobrazovať živé výsledky vašich dotazov a mutácií GraphQL.

Ak chcete prejsť do editora, otvorte v pracovnom priestore služby Fabric rozhranie API pre položku GraphQL a vyberte položku položku Dotaz v ľavom dolnom rohu obrazovky portálu.

Snímka obrazovky znázorňujúca, kde sa možnosť Dotaz zobrazuje v ľavom dolnom rohu obrazovky služby Fabric.

Dotazy GraphQL môžete zadávať a spúšťať priamo na karte Query . Možnosti intellisense sú k dispozícii s klávesovou skratkou: CTRL + medzerník (Windows) alebo Command + Space (macOS). Vyberte položku Spustiť , čím spustíte dotaz a zodpovedajúcim spôsobom načítate údaje zo zdroja údajov.

Snímka obrazovky editora rozhrania API, ktorá obsahuje kartu Dotaz rozdelenú do tabiel Spustiť, Premenné dotazu a Výsledky.

Generovať kód

Po testovaní a prototype požadovanej operácie GraphQL môže editor rozhrania API generovať kotlicu Python alebo Node.js kód na základe dotazu alebo mutácie vykonané v editore. Vygenerovaný kód môžete spustiť lokálne na testovacie účely a časti z neho znova použiť v procese vývoja aplikácie.

Dôležité

Vygenerovaný kód používa interaktívne poverenia prehliadača a mal by sa používať iba na testovacie účely. V produkčnom prostredí vždy zaregistrujte aplikáciu v aplikácii Microsoft Entra a použite príslušné client_id a rozsahy. Komplexný príklad so vzorovým kódom nájdete v časti Pripojenie aplikácií.

Na začiatok spustite dotaz, vyberte tlačidlo Generovať kód a zodpovedajúcim spôsobom vyberte jazyk:

Snímka obrazovky editora rozhrania API po otvorení možnosti generovať kód.

Potom môžete vygenerovaný kód skopírovať a uložiť ako súbor v lokálnom priečinku. V závislosti od jazyka, ktorý si zvolíte, postupujte podľa jednoduchých krokov na lokálne testovanie:

Python
  1. Vytvorenie virtuálneho prostredia pomocou príkazu python -m venv .venv
  2. Aktivácia venv používania .venv\Scripts\activate alebo source .venv/bin/activate
  3. Inštalácia požadovanej závislosti pomocou príkazu pip install azure.identity
  4. Spustite kód pomocou python <filename.py>
Node.JS
  1. V rovnakom priečinku ako súbor, ktorý ste uložili, vytvorte package.json súbor s nasledujúcim obsahom:
{
  "type": "module",
  "dependencies": { 
  }
}
  1. Spustite npm install --save @azure/identity príkaz alebo podobný príkaz v správcovi balíkov podľa vlastného výberu a nainštalujte najnovšiu verziu knižnice identít.
  2. Spustite kód pomocou node <filename>.js

Vývoj dotazov a mutácií

Prečítajte si nasledujúcu krátku schému GraphQL, ktorá definuje jeden Post typ s dotazmi na čítanie jedného príspevku alebo zoznamu všetkých príspevkov. Definuje tiež mutácie na vytvorenie, aktualizáciu alebo odstránenie príspevkov podporujúcich všetky prípady crudl (vytvorenie, čítanie, aktualizácia, odstránenie, zoznam) prípady použitia.

type Post {
  id: ID!
  title: String!
  content: String!
  author: String!
  published: Boolean
}

type Query {
  getPost(id: ID!): Post
  getAllPosts: [Post]
}

type Mutation {
  createPost(title: String!, content: String!, author: String!): Post
  updatePost(id: ID!, title: String, content: String, author: String, published: Boolean): Post
  deletePost(id: ID!): Boolean
}

Údaje exponované prostredníctvom GraphQL môžete prečítať pomocou ľubovoľného dotazu definovaného v schéme. Dotaz getPost by mal vyzerať ako v nasledujúcom príklade.

query MyQuery {
  getPost(id: "1234") {
    title
    content
    author
  }
}

Odpoveď:

{
  "data": {
    "getPost": {
      "title": "First Post",
      "content": "This is my first post.",
      "author": "Jane Doe"
    }
  }
}

Písať údaje pomocou mutácií, ako createPost je vytvoriť príspevok s požadovanými parametrami.

mutation MyMutation {
  createPost(title: "Second post", content: "This is my second post", author: "Jane Doe", published: false) {
    id
    title
    content
    author
  }
}

Odpoveď:

{
  "data": {
    "createPost": {
      "id": "5678",
      "title": "Second Post",
      "content": "This is my second post.",
      "author": "Jane Doe"
    }
  }
}

Premenné dotazu

Pomocou tably Premenné dotazu na pravej strane karty Dotaz odovzdajte všetky parametre ako premenné do dotazov alebo mutácií. Premenné fungujú rovnakým spôsobom ako premenné v akomkoľvek inom programovacom jazyku. Každá premenná musí byť deklarovaná pomocou názvu, ktorý sa používa na prístup k hodnote uloženej v nej. V predchádzajúcom príklade s mutáciou ju môžete mierne upraviť tak, aby ste mohli používať premenné dotazu.

mutation MyMutation ($title: String!, $content: String!, $author: String!){
  createPost(title: $title, content: $content, author: $author) {
    id
    title
    content
    author
  }
}

Definujte premenné na table ako v nasledujúcom príklade.

    {
      "id": "5678",
      "title": "Second Post",
      "content": "This is my second post.",
      "author": "Jane Doe"
    }

Premenné uľahčujú čítanie, testovanie a úpravu parametrov kódu mutácie a uľahčujú čítanie, testovanie a úpravu parametrov.