GraphQL API-k importálása

A KÖVETKEZŐRE VONATKOZIK: Minden API Management-szint

Az API Managementben hozzáadhat egy GraphQL API-t két modell egyikéhez: átadhatja egy meglévő GraphQL-végpontnak, vagy importálhat egy GraphQL-sémát, és létrehozhat egy szintetikus GraphQL API-t egyéni mezőfeloldókkal. További információkért tekintse meg a GraphQL áttekintését.

Ebben a cikkben a következőt fogja:

• Adjon hozzá egy átmenő GraphQL API-t az API Management-példányhoz.
• Tesztelje a GraphQL API-t.

Ha egy GraphQL-sémát szeretne importálni, és REST vagy SOAP API-végpontok használatával szeretne mezőfeloldókat beállítani, olvassa el a GraphQL-séma importálása és a mezőfeloldók beállítása című témakört.

Előfeltételek

• Egy meglévő API Management-példány. Hozzon létre egyet, ha még nem tette meg.

• A GraphQL API.

• Azure CLI

  • Használja a Bash-környezetet az Azure Cloud Shellben. További információ: A Bash rövid útmutatója az Azure Cloud Shellben.

    

  • Ha inkább helyi cli-referenciaparancsokat szeretne futtatni, telepítse az Azure CLI-t. Ha Windows vagy macOS rendszert használ, fontolja meg az Azure CLI Docker-tárolóban való futtatását. További információ: Az Azure CLI futtatása Docker-tárolóban.

    • Ha helyi telepítést használ, jelentkezzen be az Azure CLI-be az az login parancs futtatásával. A hitelesítési folyamat befejezéséhez kövesse a terminálon megjelenő lépéseket. További bejelentkezési lehetőségekért lásd : Bejelentkezés az Azure CLI-vel.

    • Amikor a rendszer kéri, először telepítse az Azure CLI-bővítményt. További információ a bővítményekről: Bővítmények használata az Azure CLI-vel.

    • Futtassa az az version parancsot a telepített verzió és a függő kódtárak megkereséséhez. A legújabb verzióra az az upgrade paranccsal frissíthet.

• Azure PowerShell

  • Ha az Azure PowerShell helyi használatát választja:
    • Telepítse az Az PowerShell-modul legújabb verzióját.
    • Csatlakozás az Azure-fiókjába az Csatlakozás-AzAccount parancsmag használatával.
  • Ha az Azure Cloud Shell használata mellett dönt:
    • További információkért tekintse meg az Azure Cloud Shell áttekintését.

GraphQL API hozzáadása

Portál

1. Az Azure Portalon keresse meg az API Management-példányt.

2. A bal oldali menüben válassza az API-k>+ API hozzáadása lehetőséget.

3. Az Új API definiálása területen válassza a GraphQL ikont.

   

4. A párbeszédpanelen válassza a Teljes elemet, és töltse ki a szükséges űrlapmezőket.

   

   Mező	Leírás
   Megjelenített név	Az a név, amellyel a GraphQL API megjelenik.
   Név	A GraphQL API nyers neve. A megjelenítendő név beírása közben automatikusan feltöltődik.
   GraphQL-típus	Válassza az átmenő GraphQL lehetőséget egy meglévő GraphQL API-végpontból való importáláshoz.
   GraphQL API-végpont	Az alap URL-cím a GraphQL API-végpont nevével. Például: https://example.com/your-GraphQL-name Használhat egy gyakori "swapi" GraphQL-végpontot is, például https://swapi-graphql.azure-api.net/graphql egy bemutatót.
   Séma feltöltése	Lehetőség van a sémafájl tallózására és feltöltésére a GraphQL-végpontról lekért séma lecseréléséhez (ha van ilyen).
   Leírás	Adja meg az API leírását.
   URL-séma	Válasszon a GraphQL-végpont alapján. Válassza ki a WebSocket-sémát (WS vagy WSS) tartalmazó lehetőségek egyikét, ha a GraphQL API tartalmazza az előfizetés típusát. Alapértelmezett kijelölés: HTTP(S).
   API URL-címének utótagja	Adjon hozzá egy URL-utótagot az adott API azonosításához ebben az API Management-példányban. Ennek egyedinek kell lennie ebben az API Management-példányban.
   Kiindulási URL-cím	Az API-alap URL-címét megjelenítő nem szerkeszthető mező
   Címkék	A GraphQL API társítása új vagy meglévő címkékkel.
   Termékek	A GraphQL API társítása egy termékkel a közzétételhez.
   Verziószámba iktassa ezt az API-t	Válassza ki, ha verziószámozási sémát szeretne alkalmazni a GraphQL API-ra.

5. Válassza a Létrehozás lehetőséget.

6. Az API létrehozása után tallózzon vagy módosítsa a sémát a Tervezés lapon.

Azure CLI

Az alábbi példa az az apim api import parancsával importál egy GraphQL-átengedési API-t a megadott URL-címről egy apim-hello-world nevű API Management-példányba.

# API Management service-specific details
APIMServiceName="apim-hello-world"
ResourceGroupName="myResourceGroup"

# API-specific details
APIId="my-graphql-api"
APIPath="myapi"
DisplayName="MyGraphQLAPI"
SpecificationFormat="GraphQL"
SpecificationURL="<GraphQL backend endpoint>"

# Import API
az apim api import --path $APIPath --resource-group $ResourceGroupName \
    --service-name $APIMServiceName --api-id $APIId \
    --display-name $DisplayName --specification-format $SpecificationFormat --specification-url $SpecificationURL

Az API importálása után szükség esetén az az apim api update paranccsal frissítheti a beállításokat.

PowerShell

Az alábbi példa az Import-AzApiManagementApi Azure PowerShell-parancsmaggal importál egy GraphQL-átengedési API-t a megadott URL-címről egy apim-hello-world nevű API Management-példányba.

# API Management service-specific details
$apimServiceName = "apim-hello-world"
$resourceGroupName = "myResourceGroup"

# API-specific details
$apiId = "my-graphql-api"
$apiPath = "myapi"
$specificationFormat = "GraphQL"
$specificationUrl = "<GraphQL backend endpoint>"

# Get context of the API Management instance. 
$context = New-AzApiManagementContext -ResourceGroupName $resourceGroupName -ServiceName $apimServiceName

# Import API
Import-AzApiManagementApi -Context $context -ApiId $apiId -SpecificationFormat $specificationFormat -SpecificationUrl $specificationUrl -Path $apiPath

Az API importálása után szükség esetén a Set-AzApiManagementApi parancsmaggal frissítheti a beállításokat.

A GraphQL API tesztelése

1. Lépjen az API Management-példányra.

2. Az oldalnavigációs menü API-k csoportjában válassza az API-kat.

3. A Minden API területen válassza ki a GraphQL API-t.

4. A tesztkonzol eléréséhez válassza a Teszt fület.

5. Fejlécek alatt:

   1. Válassza ki a fejlécet a Név legördülő menüből.
   2. Adja meg az értéket az Érték mezőben.
   3. További fejlécek hozzáadásához válassza a +Fejléc hozzáadása lehetőséget.
   4. Fejlécek törlése a kuka ikonnal.

6. Ha hozzáadott egy terméket a GraphQL API-hoz, alkalmazza a termék hatókörét a Termékhatókör alkalmazása területen.

7. A Lekérdezésszerkesztőben a következők valamelyike:

   1. Jelöljön ki legalább egy mezőt vagy almezőt az oldalmenüben lévő listából. A kiválasztott mezők és almezők megjelennek a lekérdezésszerkesztőben.

   2. Kezdjen el gépelni a lekérdezésszerkesztőben egy lekérdezés megírásához.

      

8. A Lekérdezés változók csoportban adjon hozzá változókat ugyanazon lekérdezés vagy mutáció újrafelhasználásához, és adjon át különböző értékeket.

9. Válassza az Küldés lehetőséget.

10. Tekintse meg a választ.

    

11. Ismételje meg az előző lépéseket a különböző hasznos adatok teszteléséhez.

12. Ha a tesztelés befejeződött, lépjen ki a tesztkonzolból.

Előfizetés tesztelése

Ha a GraphQL API támogatja az előfizetést, tesztelheti azt a tesztkonzolon.

1. Győződjön meg arról, hogy az API lehetővé teszi az API-nak megfelelő WebSocket URL-sémát (WS vagy WSS). Ezt a beállítást a Gépház lapon engedélyezheti.

2. Állítson be egy előfizetési lekérdezést a lekérdezésszerkesztőben, majd válassza a Csatlakozás a WebSocket-kapcsolat létrehozásához a háttérszolgáltatáshoz.

   

3. Tekintse át a kapcsolat részleteit az Előfizetés panelen.

   

4. Az előfizetett események megjelennek az Előfizetés panelen. A WebSocket-kapcsolat mindaddig megmarad, amíg le nem választja, vagy nem csatlakozik egy új WebSocket-előfizetéshez.

   

A GraphQL API védelme

A GraphQL API biztonságossá tételéhez alkalmazza a meglévő hitelesítési és engedélyezési szabályzatokat , valamint egy GraphQL-érvényesítési szabályzatot a GraphQL-specifikus támadások elleni védelem érdekében.

Kapcsolódó témakörök

• API-importálási korlátozások
• OpenAPI-specifikáció importálása
• SOAP API importálása
• SOAP API importálása és konvertálása REST-té
• App Service API importálása
• Container App API importálása
• WebSocket API importálása
• GraphQL API-k importálása
• GraphQL-sémák importálása és mezőfeloldók beállítása
• Azure-függvényalkalmazás importálása
• Azure Logic App-alkalmazás importálása
• Service Fabric-szolgáltatás importálása
• Azure OpenAI API importálása
• OData API importálása
• SAP OData-metaadatok importálása
• GRPC API importálása
• API szerkesztése

Következő lépések

Közzétett API átalakítása és védelme